Coding Systems

= Overview =

Indivo contains several coding systems in its code base, many of which are simply XML versions of existing, industry-standard codes provided by CDC, HL7, ISO, etc. These XML-based coding systems are hosted at indivo.org for universal reference, in addition to coding systems (like NDC and ICD9) which are served from a database (due to their size and complexity).

= Coding System Web Service =

Each Indivo-compatible coding system is identified by a service location, for example:

  http://indivo.org/codingsystems/hl7-marital-3.0  Marital Status

The service location resolves to a REST-based web service that supports the commands below. The definitive coding system web service is hosted at indivo.org, but you may deploy a local mirror for redundancy and decreased latency. See Installation:3.2 Indivo Deployment Utilities for web service installation instructions.

Request information about a coding system
To view basic information about a coding system, simply visit the service location URL.

Live Example: http://indivo.org/codingsystems/hl7-marital-3.0

The result will be an XML CodingSystem block.

View all available values within a coding system
To view all coded values defined within a coding system, along with basic information about the system, append  to the service location URL.

Live Example: http://indivo.org/codingsystems/hl7-marital-3.0/list

The result will be an XML CodingSystem block, including several CodeDefinition blocks. This function may not be supported by all coding systems, especially systems drawn from very large databases.

Extract a single value from a coding system by code
You may extract a single value, along with all available details, from a coding system, by appending  to the service URL, followed by the code desired.

Live Example: http://indivo.org/codingsystems/hl7-marital-3.0/lookup/M

The result will be a single XML CodeDefinition block.

Generate a CodedValueType for insertion in a document
When you want to use a coded value within a document, you may generate the necessary XML by appending  to the service URL, followed by the code desired.

Live Example: http://indivo.org/codingsystems/hl7-marital-3.0/generate/M

The result will be a single XML CodedValueType block.

= Indivo 3.0 Coding Systems =


 * cdc-ethnicity-1.0.xml
 * Ethnicity values - US CDC


 * cdc-race-1.0.xml
 * Race values - US CDC


 * hl7-abnormal-flag-2.5.xml
 * Lab test abnormal (high/low value) flags - HL7


 * hl7-address-type-3.0.xml
 * Address type (mailing, etc.) - HL7


 * hl7-allergen-types-2.5.xml
 * Allergen types - HL7


 * hl7-education-3.0.xml
 * Highest education level - HL7


 * hl7-marital-3.0.xml
 * Marital status - HL7


 * hl7-religion-2.5.xml
 * Religions - HL7


 * hl7-route-2.5.xml
 * Route of medication administration - HL7


 * hl7-sex-2.5.xml
 * Sex - HL7


 * hl7-vaccines-2006.xml
 * Vaccines administered - HL7


 * indivo-appointment-care-class-1.0.xml
 * Appointment care classes (inpatient, outpatient, etc.)


 * indivo-appointment-status-1.0.xml
 * Appointment statuses (scheduled, complete, canceled, etc.)


 * indivo-duration-units-1.0.xml
 * Units of measure for duration, using the Unified Code for Units of Measure.


 * indivo-history-conditions-1.0.xml
 * Codes for specifying salient medical conditions within a family.


 * indivo-lab-status-1.0.xml
 * To identify the status of a lab order.


 * indivo-lab-units-1.0.xml
 * Common compound units of measure for lab results, using the Unified Code for Units of Measure.


 * indivo-med-units-1.0.xml
 * Common compound units of measure for medication doses, according to the Multum Lexicon. Coded using the Unified Code for Units of Measure.


 * indivo-medical-relationships-1.0.xml
 * Common medical professions, primarily for use in contact information.


 * indivo-medical-specialties-1.0.xml
 * American Medical Association self-designated practice specialties.


 * indivo-note-types-1.0.xml
 * To identify note document type.


 * indivo-org-relationships-1.0.xml
 * Common medically-relevant organizational relationships, primarily for use in contact information.


 * indivo-personal-relationships-1.0.xml
 * Common family relationships, primarily for use in contact information and family history.


 * indivo-settings-1.0.xml
 * Patient care settings, mostly compatible with HL7 "Patient Class" codes.


 * indivo-vitals-1.0.xml
 * Common vital measurements (temperature, height, weight, etc.)


 * iso-languages-639-2.xml
 * 3-character ISO 639-2 codes for world languages currently in use.


 * ucum.xml
 * The Unified Code for Units of Measure.