Common Types

Overview
Indivo's common types are small type definitions that are reused throughout our document model.

Schema

 * Syntax-Highlighted Schema
 * Raw Schema

DurationType
A means to specify a duration in time, using a start date and an end date.


 * dateTime (required)
 * The date and time this duration began or will begin.
 * The date and time this duration began or will begin.


 * dateTime (optional)
 * The date and time this duration ended or will end. Leave this field undefined if an open-ended duration is desired.
 * The date and time this duration ended or will end. Leave this field undefined if an open-ended duration is desired.

EndorsementType
Used to describe a physical signature on a document. (This does not constitute a digital signature.)


 * string (optional)
 * Signatory's first name.
 * Signatory's first name.


 * string (optional)
 * Signatory's first name.
 * Signatory's first name.


 * string (optional)
 * Signatory's professional role, as pertinent to the document signed, e.g. attending physician, nurse, pharmacist.
 * Signatory's professional role, as pertinent to the document signed, e.g. attending physician, nurse, pharmacist.


 * string (optional)
 * Signatory's identifier within the institution giving him authority to endorse a document.
 * Signatory's identifier within the institution giving him authority to endorse a document.


 * dateTime (optional)
 * The date and time this endorsement was made.
 * The date and time this endorsement was made.

ImageType
A means to include a binary image with information about its data format.


 * string (required)
 * The Multipurpose Internet Mail Extensions content type of this image.
 * Usage: Choose a content type as defined by the IANA, e.g. image/jpeg.
 * Usage: Choose a content type as defined by the IANA, e.g. image/jpeg.


 * base64Binary (required)
 * The image's binary data.
 * The image's binary data.

CodedValueType
For a full review of Indivo coding systems, see Coding Systems.

Used to make a formal reference to a code within a coding system.


 * CodingSystemReferenceType (required)
 * The coding system from which this code has been drawn.
 * The coding system from which this code has been drawn.


 * string (required)
 * The code itself.
 * The code itself.


 * string (required)
 * This field is used either to record the original data that was converted into this coded value, or the textual value shown to an end-user which lead him to choose this code. If the original coding system were no longer accessible, it could be used to reidentify the code's intent.
 * This field is used either to record the original data that was converted into this coded value, or the textual value shown to an end-user which lead him to choose this code. If the original coding system were no longer accessible, it could be used to reidentify the code's intent.

CodingSystemReferenceType

 * anyURI (required)
 * The authoritative Internet-accessible location of the web service that handles requests for this coding system. This location will always be a URL at http://indivo.org, even if a particular deployment is using another web service for resolving Indivo codes.
 * The authoritative Internet-accessible location of the web service that handles requests for this coding system. This location will always be a URL at http://indivo.org, even if a particular deployment is using another web service for resolving Indivo codes.


 * string (required)
 * The coding system's short description. This is defined within the coding system, and should be retrievable from the coding system web service.
 * The coding system's short description. This is defined within the coding system, and should be retrievable from the coding system web service.

DoubleRangeType
Used for specifying a range of values based on the "double" numeric type, with an optional unit of measure. Minimum and maximum values are inclusive.


 * double (optional)
 * Minimum value in range. If open-ended (maximum or less), leave this field undefined.
 * Minimum value in range. If open-ended (maximum or less), leave this field undefined.


 * double (optional)
 * Maximum value in range. If open-ended (minimum or more), leave this field undefined.
 * Maximum value in range. If open-ended (minimum or more), leave this field undefined.


 * CodedValueType (optional)
 * A unit of measure.
 * &raquo; Refer to coding systems indivo-med-units-1.0 and indivo-lab-units-1.0.
 * &raquo; Refer to coding systems indivo-med-units-1.0 and indivo-lab-units-1.0.

IntegerRangeType
Used for specifying a range of values based on the "integer" numeric type, with an optional unit of measure. Minimum and maximum values are inclusive.


 * integer (optional)
 * Minimum value in range. If open-ended (maximum or less), leave this field undefined.
 * Minimum value in range. If open-ended (maximum or less), leave this field undefined.


 * integer (optional)
 * Maximum value in range. If open-ended (minimum or more), leave this field undefined.
 * Maximum value in range. If open-ended (minimum or more), leave this field undefined.


 * CodedValueType (optional)
 * A unit of measure.
 * &raquo; Refer to coding systems indivo-med-units-1.0 and indivo-lab-units-1.0.
 * &raquo; Refer to coding systems indivo-med-units-1.0 and indivo-lab-units-1.0.

AuthorType
Used to indicate a document or annotation's author.


 * AnyIdType (required)
 * Indivo identifier (username) of a annotations's author.
 * Indivo identifier (username) of a annotations's author.


 * string (optional)
 * Full name of the author.
 * Full name of the author.


 * RoleType (required)
 * The system role held by the author.
 * The system role held by the author.