Immunization

From OpenIndivo Documentation Wiki

Contents 1 Overview 2 Schema 3 Detailed Schema Description 3.1 ImmunizationType 3.2 VaccineType 4 XML Usage Example

Overview

In Indivo parlance, an "immunization" is a single instance of receiving a "vaccine." Our model reflects that distinction. The VaccineType describes the core data of a vaccine, and the ImmunizationType describes the incidental data of a vaccine's application.

Schema

• Syntax-Highlighted Schema
• Raw Schema

Detailed Schema Description

ImmunizationType

Date

dateTime (optional)

The date the patient received the immunization.

Origin

ConciseContactInformationType (optional)

The institution which provided the data in this document.

Comments

string (optional)

Any free-text comments about this document.

Provider

ConciseContactInformationType (optional)

The provider who ordered the immunization.

EncounterId

string (optional)

An identifier which is unique across an Indivo Record, used to identify documents which originated from a discrete health encounter.

Vaccine

VaccineType (required)

The vaccine administered.

Sequence

string (optional)

Immunization sequence number.

AnatomicSurface

string (optional)

The anatomic surface through which the vaccine was administered.

AdverseEvent

string (optional)

Free-text description of an adverse event caused by this immunization.

ConsentFlag

string (optional)

Indicator of patient consent to receive vaccine.

AdministeredBy

ConciseContactInformationType (optional)

The provider who gave the immunization. This may often be the same as the Provider field.

VaccineType

Vaccines may be specified by either textual name or by code, not both.

Code

CodedValueType (optional)

Vaccine code.

» Refer to coding system hl7-vaccines-2006.

Name

string (optional)

A textual name may be specified if a code is not available.

Manufacturer

string (optional)

The manufacturer of this vaccine.

Lot

string (optional)

Vaccine lot.

Route

string (optional)

How the vaccine is applied.

Expiration

dateTime (optional)

The vaccine's expiration date.

XML Usage Example

Out of date.

<Immunization>
   <Date>2004-09-22T00:00:00.000-04:00</Date>
   <Origin>
     <OrganizationName>Children's Hospital Boston</OrganizationName>
     <Address>
       <Type>Business</Type>
       <Priority>1</Priority>
       <StreetAddress1>300 Longwood Avenue</StreetAddress1>
       <City>Boston</City>
       <State>MA</State>
       <PostalCode>02115</PostalCode>
       <Country>USA</Country>
     </Address>
   </Origin>
   <Vaccine>
     <Code>
       <CodingSystem>
         <Format>ping-xml</Format>
         <Name>HL7 Vaccine Codes</Name>
         <Location>http://ping.chip.org/codes/vaccine-1.0.xml</Location>
         <MajorVersion>1</MajorVersion>
         <MinorVersion>0</MinorVersion>
       </CodingSystem>
       <Value>19</Value>
     </Code>
   </Vaccine>
   <Sequence>1</Sequence>
 </Immunization>