Common Types

From OpenIndivo Documentation Wiki

Jump to: navigation, search

Main Page < Contact < Common Types

1 Overview
2 Schema
3 Detailed Schema Description
4 XML Usage Examples

[edit]

Overview

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

[edit]

Schema

[edit]

Detailed Schema Description

[edit]

DurationType

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

StartDate: dateTime (required); The date and time this duration began or will begin.

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

[edit]

EndorsementType

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

FirstName: string (optional); Signatory's first name.

LastName: string (optional); Signatory's first name.

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

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

SignatureDate: dateTime (optional); The date and time this endorsement was made.

[edit]

ImageType

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

MimeType

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.

Data: base64Binary (required); The image's binary data.

[edit]

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.

CodingSystem: CodingSystemReferenceType (required); The coding system from which this code has been drawn.

Code: string (required); The code itself.

HistoricalValue: 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.

[edit]

CodingSystemReferenceType

ServiceLocation: 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.

ShortDescription: 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.

[edit]

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.

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

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

Unit

CodedValueType (optional)

A unit of measure.

» Refer to coding systems indivo-med-units-1.0 and indivo-lab-units-1.0.

[edit]

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.