Dossia Schemas
From Dossia Wiki
Dossia Data Type Definitions
Dossia is dedicated to the open exchange of personal health related information. To accomplish this goal, we have consolidated the most popular industry standards into a comprehensive and flexible set of data schemas. Our data elements primarily focus on the most common data types available across the healthcare landscape. Not only are our schemas consistent with the current industry standards, they also have been validated against actual data from health plans, providers, PBMs, human resource systems, and retail sources. As our catalog of data sources expands, we will update and enhance the Dossia data schemas. Suggestions and comments are welcome. Please post on the XML Schema discussion group at the Dossia Development Community. We believe that the best way to gain and grow our schema and vocabularies is through the input of others using our schema.
If you are unfamiliar with XML schema or in need of a refresh, w3schools provides an excellent tutorial here.
Use of Enumerated Lists
We have made every attempt to make sure data is codified. Our philosophy is to only store the rawest form of the data. For example, for the element "waist size", we store the actual waist measurement in inches. This will allow any of the personal health applications to convert the value to another format/unit if required. This strategy may pose a challenge for some PHAs that do not collect data in this manner. For example, if a PHA stores waist size as "under 30 inches", "30 to 42 inches" or "over 42 inches", a specific value may not be available. If the PHA does not collect the rawest form of a value, then Dossia will not accept the information. A large number of the data elements Dossia has implemented are of a specific form. For these data types, Dossia has implemented specific sets of predefined values identified in our Dossia Enumerated Listings.
Note about Dates as a DurationType. In all cases where a date does not have a duration the StartDate is only used. Also the same Date element with different attributes are used to represent schedule/ordered vs. actual/completed. Other attributes include the ability to indicate approximate dates as well as cancelled dates.
We have intentionally included the PersonalHealthData elements in other schemas that extend this type. For clarity these elements are defined within multiple schemas to assist in the appropriate use and to minimize incorrect or differing interpretations.
To download the complete zipped version of the XSDs go to http://www.dossia.org/v2.0/
Use of Coding Systems
Coding System element types allow for data to be stored in Dossia with reference to an industry standard. Dossia currently supports the following coding systems:
- ICD - International Classification of Diseases
- CPT - Current Procedural Terminology
- CDT - Current Dental Terminology
- CMS - Centers for Medicare and Medicaid Services
- HL7 - Health Level Seven
- NDC - National Drug Code
- LOINC - Logical Observation Identifiers Names and Codes
- RxNorm - National Library of Medicine's standardized nomenclature for clinical drugs and drug delivery devices
- SNOMEDCT- Systematized Nomenclature of Medicine - Clinical Terms
In order to manage the various versions of coding systems including annual updates, every time a coding system is used Dossia requires a Major and Minor Version to be referenced. Dossia has indicated the preferred coding systems for most of the data elements where a standard is available. We have done this by specifying the acceptable coding system for the element in the ComplexType Names within the CodingSystem data type. For example, the Problem data type extends the SnomedICDCodingSystemType complex type - which indicates that either SNOMED or ICD are acceptable standards to use when storing Problem data. If a specific coding system is not indicated it is expected that the StandardCodingSystem will be used. The StandardCodingSystem can indicate any one of the systems listed in the Coding System Enumerated list (listed above and identified in the List.xsd).
Although it is required to store the coded value when referencing a coding system, it is possible to store either a Long Description or a Short Description without a code in special circumstances by including the code element in the XML and leaving it blank. This should be reserved for storing self-entered textual data. Self-entered data is defined as information that the user enters (textual or codified), and also MUST be indicated in the ProfessionallySourced element of the PersonalHealthDataType.
Allergy
Contains information related to an individual's current or historical allergies.
Source: http://www.dossia.org/v2.0/xml/phr/allergy.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="AllergyType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Negation" type="boolean" minOccurs="0"/>
<element name="AllergenCode" type="phr:StandardCodingSystemType" minOccurs="0"/>
<element name="Reaction" type="phr:StandardCodingSystemType" minOccurs="0"/>
<element name="Status" type="phr:StatusEnum" minOccurs="0"/>
<element name="Frequency" type="phr:AllergyFrequencyEnum" minOccurs="0"/>
<element name="Severity" type="phr:SeverityEnum" minOccurs="0"/>
</sequence>
<xsd:attribute name="class" type="phr:AllergenTypeEnum" use="required"/>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date as a DurationType allows a start and an end date.
StartDate indicates when the allergy was first observed. EndDate indicates when the allergy was no longer affecting the individual. Lifelong allergies will not have an EndDate. | | |
| Comments | Free text string containing any Comments related to the Allergy. | | |
| Provider | Information about the Provider responsible for treating this Allergy. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. Leave blank if unknown. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Allergy | |||
| Negation | Indicates if the Allergy is negated with treatment. | True if the Allergen is negated with treatment. If unknown then False. | |
| AllergenType | An attribute of AllergyType that describes the Type of Allergen. | See values for AllergenTypeEnum in List.xsd. | |
| AllergenCode | Contains the code identifying the Allergen. | The preferred vocabulary is ICD. | |
| Reaction | Contains the code identifying the Reaction. | The preferred vocabulary is ICD. | |
| Severity | Describes the severity of the allergy. | See values for SeverityEnum in List.xsd. | |
| Status | Indicates the Status of the Allergy. | See values for StatusEnum in List.xsd. | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Allergy xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" class="Medication"
ProfessionallySourced="true"
xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:AllergenCode MinorVersion="" MajorVersion=""
System="ICD">
<phr:Code>code</phr:Code>
<phr:ShortDescription>AllergenCode</phr:ShortDescription>
</phr:AllergenCode>
<phr:Reaction MinorVersion="" MajorVersion="" System="ICD">
<phr:Code>code</phr:Code>
<phr:ShortDescription>AllergenCode</phr:ShortDescription>
</phr:Reaction>
</phr:Allergy>
Annotation
Contains information related to Annotations. A user or anyone who has shared their record can create Annotations and link them to specific pieces of information - just like a Post-it note.
Source: http://www.dossia.org/v2.0/xml/phr/annotation.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="AnnotationType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Author" type="phr:ActorType"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date the Annotation was made. | | |
| Comments | Free text string containing the text of the Annotation. | | |
| Provider | N/A | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Annotation | |||
| Author | Identifies the individual who entered the Annotation. | | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Annotation xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
ProfessionallySourced="false"
xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Comments>Your leg is healing as expected & I would encourage
you to start excercising it as much as possible.</phr:Comments>
<phr:Author class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Author>
</phr:Annotation>
Appointment
Contains information about an individual's health related appointments.
http://www.dossia.org/v2.0/xml/phr/appointment.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="AppointmentType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Location" type="phr:OrganizationType" minOccurs="0"/>
<element name="CareSetting" type="phr:StandardCodingSystemType" minOccurs="0"/>
<element name="AppointmentReason" type="phr:AppointmentReasonType" maxOccurs="unbounded"/>
<element name="Status" type="phr:AppointmentTypeEnum" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="AppointmentReasonType">
<sequence>
<element name="AppointmentReason" type="phr:StandardCodingSystemType"/>
</sequence>
<attribute name="sequence" type="positiveInteger" use="required"/>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date as a DurationType allows a Start and an End date.
StartDate indicates the date of the Appointment. StartTime indicates the time of the Appointment. If there is a duration to the Appointment the EndDate and EndTime can be populated. | | |
| Comments | Free text string containing any Comments related to the Appointment. | | |
| Provider | Information about the Provider with whom the Appointment was made. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Appointment | |||
| Location | Identifies the Location of the Appointment where the service was provided. | | |
| CareSetting | Indicates the type of Care Setting associated with the Appointment. | See values for CareSettingEnum in List.xsd. | |
| AppointmentReason | Describes the Reason for the Appointment. | | |
| Status | Indicates the Status of the Appointment. | See values for AppointmentTypeEnum in List.xsd. | |
Example XML
<phr:Appointment xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
ProfessionallySourced="false"
xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Actual">
<phr:StartDate>2010-06-04</phr:StartDate>
<phr:StartTime>03:45:00.000-04:00</phr:StartTime>
<phr:EndDate>2010-06-04</phr:EndDate>
<phr:EndTime>03:55:00.000-04:00</phr:EndTime>
</phr:Date>
<phr:Location>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
<phr:Address>
<phr:StreetAddress1>1 Longwood Ave</phr:StreetAddress1>
<phr:City>Boston</phr:City>
<phr:State>MA</phr:State>
</phr:Address>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>32445</phr:Identifier>
</phr:ProviderIdentifier>
</phr:Location>
<phr:AppointmentReason sequence="1">
<phr:AppointmentReason MinorVersion=""
MajorVersion="" System="ICD">
<phr:Code></phr:Code>
<phr:ShortDescription>itchy knee</phr:ShortDescription>
</phr:AppointmentReason>
</phr:AppointmentReason>
</phr:Appointment>
BinaryData
Contains information about image files associated with a person's personal Health record.
http://www.dossia.org/v2.0/xml/phr/binaryData.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="BinaryDataType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Filename" type="string" minOccurs="0"/>
<element name="MimeType" type="string"/>
<element name="Length" type="long"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date as a DurationType allows a Start and an End date.
StartDate would be used to indicate when the document/image/file was created. | | |
| Comments | Free text string containing any Comments related to the Binary Data. | | |
| Provider | Information about the Provider associated with this document. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| BinaryData | |||
| MimeType | Describes the HTTP Mime Type. | | |
| Filename | Identifies the filename. |
| |
| Length | Length of the Binary Data. | | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:BinaryData xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ProfessionallySourced="false" xsi:schemaLocation="http://www.dossia.org/v2.0/xml/phr http://www.dossia.org/v2.0/xml/phr/binaryData.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Comments>My Broken leg</phr:Comments>
<phr:MimeType>image/jpeg</phr:MimeType>
<phr:Length>10483</phr:Length>
</phr:BinaryData>
Clinical Reports
Contains information about Clinical Reports associated with a person's personal Health record.
http://www.dossia.org/v2.0/xml/phr/clinicalReport.xsd
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="ClinicalReportType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Description" type="string" minOccurs="0"/>
<element name="Location" type="phr:OrganizationType" minOccurs="0"/>
</sequence>
<xsd:attribute name="class" type="phr:ClinicalReportTypeEnum" use="required"/>
</extension>
</complexContent>
</complexType>
<complexType name="ClinicalTopicType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Section" type="phr:ClinicalSectionType" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
<attribute name="sequence" type="positiveInteger" use="required"/>
<xsd:attribute name="class" type="phr:ClinicalTopicTypeEnum" use="required"/>
</extension>
</complexContent>
</complexType>
<complexType name="ClinicalSectionType">
<xsd:sequence>
<element name="SectionHeader" type="string" minOccurs="0" />
<element name="Notes" type="string" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date as a DurationType allows a Start and an End date. | StartDate would be used to indicate when the Clinical Report was final. | |
| Comments | Free text string containing any Comments related to the Clinical Report. | | |
| Provider | Information about the Provider responsible for generating the Clinical Report. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Clinical Reports | |||
| Clinical Section | Section describing the clinical report header and notes | | |
| Clinical Report Type | A classification of the type of report. | See values in ClinicalReportTypeEnum in Lists.xsd. |
|
| Section Header | A brief header information about notes to be followed by this section | | |
| Notes | Clinical notes | | |
Example XML
<phr:ClinicalReport xmlns:phr="http://www.dossia.org/v2.0/xml/phr" ProfessionallySourced="true"
class="Discharge">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>NEWBURRY HEALTH SYSTEM</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional" role="Attending">
<phr:Individual>
<phr:FirstName>Bob</phr:FirstName>
<phr:LastName>Jones</phr:LastName>
</phr:Individual>
</phr:Provider>
<phr:SecondaryProvider class="Medical Professional" role="Admitting">
<phr:Individual>
<phr:FirstName>Bob</phr:FirstName>
<phr:LastName>Jones</phr:LastName>
</phr:Individual>
</phr:SecondaryProvider>
<phr:Date Type="Actual">
<phr:StartDate>2009-08-18</phr:StartDate>
</phr:Date>
<phr:Description>Operative Procedure Report</phr:Description>
<phr:Location>
<phr:OrganizationName>NEWBURRY HEALTH SYSTEM</phr:OrganizationName>
</phr:Location>
</phr:ClinicalReport>
<ns2:ClinicalTopic xmlns:ns2="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
ProfessionallySourced="false"
class="FullReport"
sequence="1">
<ns2:Origin Classification="PHR">
<ns2:Organization>
<ns2:OrganizationName>Dossia</ns2:OrganizationName>
</ns2:Organization>
</ns2:Origin>
<ns2:Provider class="Medical Professional">
<ns2:Individual>
<ns2:FullName>Dr. Sue Clickle</ns2:FullName>
</ns2:Individual>
</ns2:Provider>
<ns2:Date Type="Actual">
<ns2:StartDate>2010-05-05</ns2:StartDate>
</ns2:Date>
<ns2:Section>
<ns2:Notes> NEWBURRY HEALTH SYSTEM</ns2:Notes>
<ns2:Notes>SAN ANTONIO, TEXAS</ns2:Notes>
<ns2:Notes>________________________________________________________________________________</ns2:Notes>
<ns2:Notes>PATIENT NAME: Jim, BartleM</ns2:Notes>
<ns2:Notes>SEX: M</ns2:Notes>
<ns2:Notes>ADMISSION NO: 0123456789 UR#: 1944997208</ns2:Notes>
<ns2:Notes>ADMISSION DATE: 08/14/2007 BIRTHDATE: 02/28/1976</ns2:Notes>
<ns2:Notes>PATIENT TYPE: EIP LOCATION: E5T ROOM: 512</ns2:Notes>
<ns2:Notes>DISCHARGE DATE:</ns2:Notes>
<ns2:Notes>________________________________________________________________________________</ns2:Notes>
<ns2:Notes>DATE OF PROCEDURE:</ns2:Notes>
<ns2:Notes>08/11/2010</ns2:Notes>
<ns2:Notes>SURGEON:</ns2:Notes>
<ns2:Notes>Dr. Geddis.</ns2:Notes>
<ns2:Notes>ANESTHESIA:</ns2:Notes>
<ns2:Notes>Dr. Lucy Ball.</ns2:Notes>
<ns2:Notes>NAME OF PROCEDURE:</ns2:Notes>
<ns2:Notes>Repair of left inguinal hernia.</ns2:Notes>
<ns2:Notes>DESCRIPTION OF PROCEDURE:</ns2:Notes>
<ns2:Notes>This chronically ill patient was known to have severe smoking problems</ns2:Notes>
<ns2:Notes>as well as heart disease with a pacemaker. He had been cleared for</ns2:Notes>
<ns2:Notes>surgery by the cardiologist. He also had been seen by hematologist, had</ns2:Notes>
<ns2:Notes>been taken off his Plavix and prior to surgery, the patient was given</ns2:Notes>
<ns2:Notes>cryoprecipitate. During surgery, he would be given platelets.</ns2:Notes>
<ns2:Notes>The procedure was done as follows:</ns2:Notes>
<ns2:Notes>This patient was given a general anesthetic by LMA, SCD leg wraps were</ns2:Notes>
<ns2:Notes>put on. The left groin was shaved and then prepped and draped in a</ns2:Notes>
<ns2:Notes>sterile manner. A left inguinal incision was made and carried through</ns2:Notes>
<ns2:Notes>the skin and subcutaneous tissues. One small vein was clamped and</ns2:Notes>
<ns2:Notes>ligated with 3-0 plain catgut. The hernia was quickly encountered.</ns2:Notes>
<ns2:Notes>There was a large bulge coming through the floor of the inguinal canal.</ns2:Notes>
<ns2:Notes>This was quickly separated from the cord structures. Care was taken to</ns2:Notes>
<ns2:Notes>protect the vas deferens and other vessels. A Penrose drain was placed</ns2:Notes>
<ns2:Notes>around the cord structures. The testicle was kept in the scrotum. The</ns2:Notes>
<ns2:Notes>hernia was very large and very direct. No attempt was made to open the</ns2:Notes>
<ns2:Notes>sac; it was merely pushed back into the preperitoneal space. It was</ns2:Notes>
<ns2:Notes>held there with a large mesh plug using 2-0 Vicryl sutures all the way</ns2:Notes>
<ns2:Notes>around. Then a mesh patch was trimmed to fit in the floor of the</ns2:Notes>
<ns2:Notes>inguinal canal. It was anchored to the pubic tubercle with 0 Prolene</ns2:Notes>
<ns2:Notes>and to the conjoined tendon with 0 Prolene and to the shelving edge of</ns2:Notes>
<ns2:Notes>the inguinal ligament with 0 Prolene. The wings of the patch were tied</ns2:Notes>
<ns2:Notes>behind the cord with 0 Prolene. A good snug repair was obtained. The</ns2:Notes>
<ns2:Notes>field was thoroughly soaked in bacitracin solution. Then the external</ns2:Notes>
<ns2:Notes>oblique fascia was closed with interrupted 2-0 Vicryl suture.</ns2:Notes>
<ns2:Notes>Approximately 10 mL of 0.5% Marcaine was injected into the cord and into</ns2:Notes>
<ns2:Notes>the subcutaneous tissues. The subcutaneous tissues were then</ns2:Notes>
<ns2:Notes>approximated with 3-0 plain catgut and the skin was closed with staples.</ns2:Notes>
<ns2:Notes>A light dressing was put on and the patient had a binder placed around</ns2:Notes>
<ns2:Notes>his abdomen followed by Jackstrap. He was returned to the Recovery Room</ns2:Notes>
<ns2:Notes>in stable condition.</ns2:Notes>
<ns2:Notes>Dictated By: Robert Smith, MD</ns2:Notes>
<ns2:Notes>CC:</ns2:Notes>
<ns2:Notes/>
</ns2:Section>
</ns2:ClinicalTopic>
CodingSystem
Provides a model for capturing data with respect to a standard coding system.
Source: http://www.dossia.org/v2.0/xml/phr/codingSystem.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/lists.xsd"/>
<element name="StandardCodingSystem" type="phr:StandardCodingSystemType"/>
<complexType name="StandardCodingSystemType">
<sequence>
<element name="Code" type="string" minOccurs="0"/>
<element name="ShortDescription" type="string" minOccurs="0"/>
<element name="LongDescription" type="string" minOccurs="0"/>
</sequence>
<attribute name="System" type="phr:CodingSystemEnum" use="required"/>
<attribute name="MajorVersion" type="string" use="required"/>
<attribute name="MinorVersion" type="string" use="required"/>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| CodingSystem | |||
| Code | The exact standard value defined by the System indicated. | | |
| ShortDescription | The exact standard short description. | | |
| LongDescription | The exact standard long description. | | |
| MajorVersion | An attribute used to indicate the Major Version of the coding system to be referenced. | | |
| MinorVersion | An attribute used to indicate the Minor Version of the coding system to be referenced. | | |
| StandardCodingSystem | |||
| System | An attribute of the CodingSystem that identifies the Standard Coding System. | See values for CodingSystemEnum in List.xsd. | |
| ICDCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the ICD Coding System. | See values for CodingSystemEnum in List.xsd. | |
| CMSCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of a CMS Coding System. | See values for CodingSystemEnum in List.xsd. | |
| CPTCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the CPT Coding System. | See values for CodingSystemEnum in List.xsd. | |
| HL7CPTCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the HL7 or the CPT Coding System. | See values for CodingSystemEnum in List.xsd. | |
| NDCCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the NDC Coding System. | See values for CodingSystemEnum in List.xsd. | |
| DentalCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the Dental Coding System. | See values for CodingSystemEnum in List.xsd. | |
| LOINCCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the LOINC Coding System. | See values for CodingSystemEnum in List.xsd. | |
| HL7CodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the HL7 Coding System. | See values for CodingSystemEnum in List.xsd. | |
| CPTLOINCCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the CPT or the LOINC Coding System. | See values for CodingSystemEnum in List.xsd. | |
| NDCRxNormCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the NDC or the RxNorm Coding System. | See values for CodingSystemEnum in List.xsd. | |
| SnomedICDCodingSystem | |||
| System | An attribute of the CodingSystem that indicates the use of the SNOMED or the ICD Coding System. | See values for CodingSystemEnum in List.xsd. | |
| MedicationCodingSystem | |||
| Code | The exact standard value defined by the System indicated. | | |
| TradeName | The descriptive Trade Name as defined by the coding system. | | |
| Generic | The descriptive Generic name as defined by the coding system. | | |
| Manufacturer | The textual name of the Manufacturer as defined by the coding system. | | |
| Form | The descriptive Form as defined by the coding system. | | |
| Strength | The descriptive Strength as defined by the coding system. | | |
| Route | The descriptive Route as defined by the coding system. | | |
| Concentration | The descriptive Concentration as defined by the coding system. | | |
| System | An attribute of the MedicationCodingSystem that identifies the Standard Coding System. | See values for CodingSystemEnum in List.xsd. | |
| MajorVersion | An attribute used to indicate the Major Version of the coding system to be referenced. | | |
| MinorVersion | An attribute used to indicate the Minor Version of the coding system to be referenced. | | |
Example XML
<?xml version="1.0" encoding="UTF-8"?> <phr:StandardCodingSystem xsi:schemaLocation="http://www.dossia.org/v2.0/xml/phr codingSystem.xsd" xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <phr:CodingSystem MajorVersion="String" MinorVersion="String" System="ICD"> <phr:Code>String</phr:Code> <phr:ShortDescription>String</phr:ShortDescription> <phr:LongDescription>String</phr:LongDescription> </phr:CodingSystem> </phr:StandardCodingSystem>
Dental
Contains information about an individual's dental health.
Source: http://www.dossia.org/v2/xml/phr/dental.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="DentalType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="ToothNumber" type="string" minOccurs="0" />
<element name="Surface" type="phr:DentalSurfaceEnum" minOccurs="0" />
<element name="Quadrant" type="phr:DentalQuadrantEnum" minOccurs="0" />
<element name="Code" type="phr:StandardCodingSystemType"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date as a DurationType allows a Start and an End Date.
StartDate would be used to indicate the date the service was provided. | | |
| Comments | Free text string containing any Comments related to the dental service. | | |
| Provider | Information about the Provider responsible for treating this user. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Dental | |||
| ToothNumber | Indicates the standard Tooth Number related to the service provided. | | |
| Surface | Indicates the Surface related to the service provided. | See values for DentalSurfaceEnum in List.xsd. | |
| Quadrant | Indicates the Quadrant related to the service provided. | See values for DentalQuadrantEnum in List.xsd. | |
| Code | Contains the Code for the service provided. | See DentalCodingSystemType in CodingSystem . | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Dental xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ProfessionallySourced="true" xsi:schemaLocation="http://www.dossia.org/v2.0/xml/phr http://www.dossia.org/v2.0/xml/phr/dental.xsd">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>Blue Cross/Blue Shield of Arkansas</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider>
<phr:Individual>
<phr:FullName>Dr Thomas Tooth</phr:FullName>
<phr:Organization>
<phr:OrganizationName>Delta Dental - Brookline</phr:OrganizationName>
<phr:ProviderIdentifier Type="Dental Provider">
<phr:Identifier>324234</phr:Identifier>
</phr:ProviderIdentifier>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:ToothNumber>4</phr:ToothNumber>
<phr:Surface>Distal</phr:Surface>
<phr:Quadrant>Lower Left</phr:Quadrant>
<phr:Code System="CDT" MinorVersion="0" MajorVersion="1">
<phr:Code>D2980</phr:Code>
<phr:ShortDescription>Crown Repair</phr:ShortDescription>
</phr:Code>
</phr:Dental>
Document
Contains the Dossia document types.
Source: http://www.dossia.org/v2.0/xml/phr/documenttype.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/appointment.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/association.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/allergy.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/annotation.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/binaryData.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/clinicalReport.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/dental.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/ediMessage.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/encounter.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/equipment.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/familyHistory.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/immunization.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/insurance.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/labTest.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/measurement.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/medication.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/micro.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/problem.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/procedure.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/types.xsd"/>
<element name="payload" type="phr:payloadType"/>
<complexType name="payloadType">
<sequence>
<choice>
<element ref="phr:Document"/>
<element name="Participant" type="phr:ParticipantType"/>
</choice>
</sequence>
</complexType>
<element name="Document" abstract="true" type="phr:PersonalHealthDataType"/>
<element name="Association" type="phr:AssociationType" substitutionGroup="phr:Document"/>
<element name="Allergy" type="phr:AllergyType" substitutionGroup="phr:Document"/>
<element name="Annotation" type="phr:AnnotationType" substitutionGroup="phr:Document"/>
<element name="Measurement" type="phr:MeasurementType" substitutionGroup="phr:Document"/>
<element name="Appointment" type="phr:AppointmentType" substitutionGroup="phr:Document"/>
<element name="BinaryData" type="phr:BinaryDataType" substitutionGroup="phr:Document"/>
<element name="ClinicalReport" type="phr:ClinicalReportType" substitutionGroup="phr:Document"/>
<element name="ClinicalTopic" type="phr:ClinicalTopicType" substitutionGroup="phr:Document"/>
<element name="Dental" type="phr:DentalType" substitutionGroup="phr:Document"/>
<element name="EdiMessage" type="phr:EdiMessageType" substitutionGroup="phr:Document"/>
<element name="Encounter" type="phr:EncounterType" substitutionGroup="phr:Document"/>
<element name="Equipment" type="phr:EquipmentType" substitutionGroup="phr:Document"/>
<element name="FamilyHistory" type="phr:FamilyHistoryType" substitutionGroup="phr:Document"/>
<element name="Immunization" type="phr:ImmunizationType" substitutionGroup="phr:Document"/>
<element name="Insurance" type="phr:InsuranceType" substitutionGroup="phr:Document"/>
<element name="LabTest" type="phr:LabTestType" substitutionGroup="phr:Document"/>
<element name="Medication" type="phr:MedicationType" substitutionGroup="phr:Document"/>
<element name="MedicationCompliance" type="phr:ComplianceType" substitutionGroup="phr:Document"/>
<element name="MedicationFulfillment" type="phr:FulfillmentHistoryType" substitutionGroup="phr:Document"/>
<element name="Microbiology" type="phr:MicrobiologyType" substitutionGroup="phr:Document"/>
<element name="Prescription" type="phr:PrescriptionDetailsType" substitutionGroup="phr:Document"/>
<element name="Problem" type="phr:ProblemType" substitutionGroup="phr:Document"/>
<element name="Procedure" type="phr:ProcedureType" substitutionGroup="phr:Document"/>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| Allergy | Contains information related to an individual's current or historical allergies. | ||
| Annotation | Contains information related to Annotations. A user or anyone who has shared their record can create Annotations and link them to specific pieces of information - just like a Post-it note. | ||
| Appointment | Contains information about an individual's health related appointments. | ||
| BinaryData | Contains information about files associated with a person's personal Health record. | ||
| Dental | Contains information about an individual's dental health. | ||
| Encounter | Contains information related to an individual's current or historical health related encounters. An encounter may be a hospitalization, medical office visit, dental office visit, vision office visit, therapy, long-term care stay, or any other pertinent patient-provider interaction. | ||
| Equipment | Contains information about an individual's implanted and external medical devices and equipment that their health status depends on, as well as any pertinent equipment or device history. This data type element also contains current and historical use of durable medical equipment. | ||
| FamilyHistory | Contains information defining an individual's blood or genetic relatives in terms of relevant family health history and health risk factors. | ||
| Immunization | Contains information related to an individual's Immunization history. | ||
| Insurance | Contains information related to the individual's health insurance for medical, pharmacy, vision, as well as other benefits. | ||
| LabTest | Contains information related to lab tests and lab results. | ||
| Measurement | Contains information related to an individual's occupational, lifestyle, social, and other risk factors. Please note that this data type also contains information about an individual's vital signs, as well as any personal traits. | ||
| Medication | The Medication information related to an individual and their medications. | ||
| MedicationCompliance | The Medication Compliance information related to an individual and their medications. | ||
| MedicationFulfillment | The Medication Fulfillment information related to an individual and their medications. | ||
| Microbiology | |||
| Participant | Contains information about the Participant. | ||
| Problem | Contains information about an individual's relevant current and historical clinical problems, conditions, symptoms, findings, and complaints. | ||
| Procedure | Contains information about an individual's interventional, surgical, diagnostic, or therapeutic procedures, treatments, and health related services. |
Example XML
<?xml version="1.0" encoding="UTF-8"?> <phr:Actor xsi:schemaLocation="http://www.dossia.org/v2.0/xml/phr documenttype.xsd" xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <phr:Individual ProviderType="Doctor"> <phr:FullName>String</phr:FullName> <phr:Prefix>String</phr:Prefix> <phr:FirstName>String</phr:FirstName> <phr:MiddleName>String</phr:MiddleName> <phr:LastName>String</phr:LastName> <phr:Suffix>String</phr:Suffix> <phr:DateOfBith>1967-08-13</phr:DateOfBith> <phr:Gender>Male</phr:Gender> <phr:Address> <phr:StreetAddress1>String</phr:StreetAddress1> <phr:StreetAddress2>String</phr:StreetAddress2> <phr:County>String</phr:County> <phr:City>String</phr:City> <phr:State>String</phr:State> <phr:PostalCode>String</phr:PostalCode> <phr:Country>String</phr:Country> </phr:Address> <phr:Contact type="Home Phone">String</phr:Contact> <phr:ProviderIdentifier Type="NPI"> <phr:Identifier>String</phr:Identifier> <phr:Description>String</phr:Description> </phr:ProviderIdentifier> <phr:Organization> <phr:OrganizationName>String</phr:OrganizationName> <phr:Address> <phr:StreetAddress1>String</phr:StreetAddress1> <phr:StreetAddress2>String</phr:StreetAddress2> <phr:County>String</phr:County> <phr:City>String</phr:City> <phr:State>String</phr:State> <phr:PostalCode>String</phr:PostalCode> <phr:Country>String</phr:Country> </phr:Address> <phr:ProviderIdentifier Type="NPI"> <phr:Identifier>String</phr:Identifier> <phr:Description>String</phr:Description> </phr:ProviderIdentifier> </phr:Organization> </phr:Individual> </phr:Actor>
Encounter
Contains information related to an individual's current or historical health related encounters. An encounter may be a hospitalization, medical office visit, dental office visit, vision office visit, therapy, long-term care stay, or any other pertinent patient-provider interaction.
Source: http://www.dossia.org/v2.0/xml/phr/encounter.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="EncounterType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="EncounterId" type="string"/>
<element name="Location" type="phr:OrganizationType" minOccurs="0"/>
<element name="Consent" type="boolean" minOccurs="0"/>
<element name="DocumentFormType" type="phr:DocumentFormTypeEnum" minOccurs="0"/>
<element name="PlaceOfService" type="phr:StandardCodingSystemType" minOccurs="0"/>
</sequence>
<xsd:attribute name="class" type="phr:EncounterClassEnum" use="required"/>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date as a DurationType allows a Start and an End date.
StartDate indicates when the encounter started. EndDate indicates when the encounter ended. | | |
| Comments | Free text string containing any Comments related to the encounter. | | |
| Provider | Identifies the primary Provider for this encounter. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Encounter | |||
| EncounterId | Contains a unique identifier for the Encounter. | For claims-originating partners this field typically contains the Claim Number. | |
| Location | Identifies the Location where the service was provided. | | |
| Consent | Indicates if Consent was obtained for the encounter. | | |
| DocumentFormType | Used to indicate the type of Form used when the encounter is associated with claim originated data. | See values for DocumentFormTypeEnum in List.xsd. | |
| CareSetting | Indicates the type of Setting where the encounter took place. | See values for CareSettingEnum in List.xsd. | |
| PlaceOfService | Contains the two-digit codes placed on health care professional claims as defined by the Centers for Medicare & Medicaid Services (CMS) POS codes used throughout the health care industry. | | |
| Class | An attribute that indicates the Classification of the encounter. | See values for EncounterClassEnum in List.xsd. | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Encounter xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" class="Medical"
ProfessionallySourced="true"
xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>Blue Cross/Blue Shield of Arkansas
</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Approximate">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:EncounterId>BCBSAR-32432432</phr:EncounterId>
<phr:Location>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Location>
<phr:PlaceOfService MinorVersion="0" MajorVersion="9"
System="CMS">
<phr:Code>21</phr:Code>
</phr:PlaceOfService>
</phr:Encounter>
Equipment
Contains information about an individual's implanted and external medical devices and equipment that their health status depends on, as well as any pertinent equipment or device history. This element also contains current and historical use of durable medical equipment.
Source: http://www.dossia.org/v2.0/xml/phr/equipment.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<!--
<element name="Equipment" type="phr:EquipmentType"/>
-->
<complexType name="EquipmentType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="EquipmentName" type="phr:StandardCodingSystemType"/>
<element name="Vendor" type="phr:ActorType" minOccurs="0"/>
<element name="Model" type="string" minOccurs="0"/>
<element name="SerialNumber" type="string" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date as a DurationType allows a Start and an End date.
StartDate indicates when the equipment started being used. EndDate indicates when the equipment stopped being used. | | |
| Comments | Free text string containing any Comments related to the equipment. | | |
| Provider | Identifies the primary Provider for this equipment. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Equipment | |||
| EquipmentName | Either coded or textual description of the Equipment. | CPAP, Inflatable Cast, etc. | |
| Vendor | The name of the manufacturer of the equipment. | | |
| Model | The model of the equipment. | | |
| Serial Number | The serial number of the equipment. | | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Equipment xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
ProfessionallySourced="true"
xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:EquipmentName MinorVersion="" MajorVersion=""
System="CMS">
<phr:Code>code</phr:Code>
<phr:ShortDescription>Crutches</phr:ShortDescription>
</phr:EquipmentName>
</phr:Equipment>
FamilyHistory
Contains information defining an individual's blood or genetic relatives in terms of relevant family health history and health risk factors.
Source: http://www.dossia.org/v2.0/xml/phr/familyHistory.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/problem.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="FamilyHistoryType">
<complexContent>
<extension base="phr:ProblemType">
<sequence>
<element name="FamilyMember" type="phr:FamilyMemberEnum"/>
<choice>
<sequence>
<element name="AgeOfOnset" type="integer" minOccurs="0"/>
<element name="AgeOfResolution" type="integer" minOccurs="0"/>
</sequence>
<sequence>
<element name="DateOfBirth" type="date"/>
</sequence>
</choice>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates when the problem/condition was first identified. EndDate indicates when the problem/condition ended. | | |
| Comments | Free text string containing any Comments related to this Family History document. | | |
| Provider | Identifies the Provider associated with this Family History document. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| FamilyHistory | |||
| FamilyMember | Indicates the relationship of the Family Member to the owner of the record. | See values for FamilyMemberEnum in List.xsd. | |
| AgeOfOnset | Indicates the Age of the family member when the problem/condition started. | | |
| AgeOfResolution | Indicates the Age of the family member when the problem/condition was resolved. | | |
| DateOfBirth | Contains the Date of Birth of the family member. | | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:FamilyHistory xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" sequence="1"
ProfessionallySourced="true"
xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>Blue Cross/Blue Shield of Arkansas
</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Approximate">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Code MinorVersion="0" MajorVersion="9" System="ICD">
<phr:Code>123</phr:Code>
</phr:Code>
<phr:Status>Active</phr:Status>
<phr:Sensitive>false</phr:Sensitive>
<phr:FamilyMember>Fathers-Father</phr:FamilyMember>
<phr:AgeOfOnset>45</phr:AgeOfOnset>
<phr:AgeOfResolution>55</phr:AgeOfResolution>
</phr:FamilyHistory>
Financial (Draft)
Contains financial information about a particular visit, encounter, or service.
Source: http://www.dossia.org/v2.0/xml/phr/financial.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<!--
<element name="Financial" type="phr:FinancialType"/>
-->
<complexType name="FinancialType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="BillingProvider" type="string" minOccurs="0"/>
<element name="EncounterId" type="string" minOccurs="0"/>
<element name="Quantity" type="string"/>
<element name="Payee" type="string"/>
<element name="GrossBilledAmount" type="phr:CurrencyType" minOccurs="0"/>
<element name="ProviderDiscount" type="phr:CurrencyType" minOccurs="0"/>
<element name="AllowedAmount" type="phr:CurrencyType" minOccurs="0"/>
<element name="RequiredCoPay" type="phr:CurrencyType" minOccurs="0"/>
<element name="AmountPaidToProvider" type="phr:CurrencyType" minOccurs="0"/>
<element name="MemberDeductible" type="phr:CurrencyType" minOccurs="0"/>
<element name="FamilyDeductible" type="phr:CurrencyType" minOccurs="0"/>
<element name="PaidDate" type="date" minOccurs="0"/>
<element name="DiagnosisRelatedGroup" type="string" minOccurs="0"/>
<element name="MajorDiagnosticCategory" type="string" minOccurs="0"/>
<element name="IneligibleAmount" type="phr:CurrencyType" minOccurs="0"/>
<element name="EligibleAmount" type="phr:CurrencyType" minOccurs="0"/>
<element name="CoinsuranceAmount" type="phr:CurrencyType" minOccurs="0"/>
<element name="OtherPayerTypeCode" type="phr:OtherPayerTypeEnum" minOccurs="0"/>
<element name="OtherPayerAmount" type="phr:CurrencyType" minOccurs="0"/>
<element name="ClaimFilingCode" type="phr:ClaimFilingCodeTypeEnum" minOccurs="0"/>
<element name="PayeeCode" type="phr:PayeeCodeTypeEnum" minOccurs="0"/>
<element name="MedicarePrimaryIndicator" type="boolean" minOccurs="0"/>
<element name="RevenueCode" type="phr:StandardCodingSystemType" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | Indicates the date when the claim/invoice was submitted. | | |
| Comments | Free text string containing any Comments related to the financial data. | | |
| Provider | Identifies the Provider who was paid. | Uses the provider NPI. | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Financial | |||
| Billing Provider | Indicates the provider who submitted the claim. | Uses the provider NPI. | |
| EncounterID | Indicates the encounter document that this financial data relates to.. | | |
| Quantiy | Indicates the number of units associated with the service.. | | |
| Payee | Indicates who was paid for the service or treatment. | | |
| Gross Billed Amount | Indicates the gross billed amount from the provider. | | |
| Provider Discount | Indicates the provider discount. | | |
| Allowed Amount | Indicates the amount allowed for the service or treatment. | | |
| Required CoPay | Indicates how much the member paid as a co-pay. | | |
| Amount Paid to Provider | Indicates the amount that was paid to the provider for the service or treatment. | | |
| Member Deductible | Indicates the Member Deductible at the time of Service**. | | |
| Family Deductible | Indicates the Family Deductible at the time of Service**. | | |
| Paid Date | Indicates the date the provider was paid for the treatment or service. | | |
| Diagnosis Related Group (DRG) | Indicates the DRG assigned to this claim. | | |
| Major Diagnostic Category (MDC) | Indicates the MDC assigned to this claim. | | |
| Ineligible Amount | Indicates the amount that is not eligible for coverage. | | |
| Eligible Amount | Indicates the amount that is eligible. | | |
| Coinsurance Amount | Indicate the coinsurance amount. | | |
| Other Payer Type Code | An enumerated list of other payer types. | See values for OtherPayerTypeEnum in List.xsd. | |
| Other Payer Amount | Indicates the amount of the claim that is covered by another payer. | | |
| Claim Filing Code | An enumerated list of claim filing codes. | See values for ClaimFilingCodeTypeEnum in List.xsd. | |
| Payee Code | An enumerated list of Payee codes. | See values for PayeeCodeTypeEnum in List.xsd. | |
| Medicare Primary Indicator | Indicates if Medicare is the primary payer for this claim. | | |
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<phr:Financial xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
ProfessionallySourced="true">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>CIGNA</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Su J Lai</phr:FullName>
<phr:Address>
<phr:StreetAddress1>881 AVE MUNOZ RIVERA</phr:StreetAddress1>
<phr:City>RIO PIEDRAS</phr:City>
<phr:State>PR</phr:State>
<phr:PostalCode>00927</phr:PostalCode>
<phr:Country>USA</phr:Country>
</phr:Address>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>664505559</phr:Identifier>
<phr:Description>Performing Provider NPI</phr:Description>
</phr:ProviderIdentifier>
</phr:Individual>
</phr:Provider>
<phr:Date Type="NotAvailable">
<phr:StartDate>2010-01-01</phr:StartDate>
<phr:EndDate>2010-01-03</phr:EndDate>
</phr:Date>
<phr:Comments>8221015901245 financial info</phr:Comments>
<phr:BillingProvider>454223</phr:BillingProvider>
<phr:EncounterId>8221015901245</phr:EncounterId>
<phr:Quantity>1</phr:Quantity>
<phr:Payee>self<phr:Payee>
<phr:GrossBilledAmount currency="U S Dollars">8.38</phr:GrossBilledAmount>
<phr:ProviderDiscount currency="U S Dollars">0.00</phr:ProviderDiscount>
<phr:AllowedAmount currency="U S Dollars">0.00</phr:AllowedAmount>
<phr:RequiredCoPay currency="U S Dollars">0.00</phr:RequiredCoPay>
<phr:AmountPaidToProvider currency="U S Dollars">6.70</phr:AmountPaidToProvider>
<phr:MemberDeductible currency="U S Dollars">0.00</phr:MemberDeductible>
<phr:PaidDate>2001-01-01</phr:PaidDate>
<phr:DiagnosisRelatedGroup>01</phr:DiagnosisRelatedGroup />
<phr:MajorDiagnosticCategory>007</phr:MajorDiagnosticCategory>
<phr:IneligibleAmount currency="U S Dollars">0.00</phr:IneligibleAmount>
<phr:EligibleAmount currency="U S Dollars">8.38</phr:EligibleAmount>
<phr:CoinsuranceAmount currency="U S Dollars">1.68</phr:CoinsuranceAmount>
<phr:OtherPayerTypeCode>Regualr COB</phr:OtherPayerTypeCode>
<phr:OtherPayerAmount>50.5</phr:OtherPayerAmount>
<phr:ClaimFilingCode>Professional</phr:ClaimFilingCode>
<phr:PayeeCode>Member</phr:PayeeCode>
<phr:MedicarePrimaryIndicator>true</phr:MedicarePrimaryIndicator>
<phr:RevenueCode MajorVersion="" MinorVersion="" System="ICD">
<phr:Code>0111</phr:Code>
</phr:RevenueCode>
</phr:Financial>
Immunization
Contains information related to an individual's Immunization history.
Source: http://www.dossia.org/v2.0/xml/phr/immunization.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<!--
<element name="Immunization" type="phr:ImmunizationType"/>
-->
<complexType name="ImmunizationType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="VaccineCode" type="phr:StandardCodingSystemType"/>
<element name="Manufacturer" type="phr:OrganizationType" minOccurs="0"/>
<element name="Lot" type="string" minOccurs="0"/>
<element name="Site" type="phr:VaccineSiteEnum" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates when the vaccine was administered. | | |
| Comments | Free text string containing any comments related to this vaccine document. | | |
| Provider | Identifies the Provider associated with this Immunization. |
| |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Immunization | |||
| VaccineCode | Contains the standard code for the Vaccine given to the patient. | The preferred vocabulary is HL7 (CVX) or CPT. See CodingSystem for extended elements. | |
| Manufacturer | Contains the textual name of the manufacturer. | CVX Manufactuer List | |
| Lot | Indicates the lot as identified by the vaccine manufacturer. | | |
| Site | Indicates the location on the body, where the vaccine was administered or indicates if it was given orally. | See VaccineSiteEnum for the list of acceptable values. | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Immunization xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
ProfessionallySourced="true"
xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:VaccineCode MinorVersion="" MajorVersion=""
System="CPT">
<phr:Code>code</phr:Code>
<phr:ShortDescription>Immunization</phr:ShortDescription>
</phr:VaccineCode>
<phr:Site>Left Arm</phr:Site>
</phr:Immunization>
Insurance
Contains information related to the individual's health insurance for medical, pharmacy, vision, as well as other benefits.
Source: http://www.dossia.org/v2.0/xml/phr/insurance.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="ImmunizationType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="VaccineCode" type="phr:StandardCodingSystemType"/>
<element name="Manufacturer" type="phr:OrganizationType" minOccurs="0"/>
<element name="Lot" type="string" minOccurs="0"/>
<element name="Site" type="phr:VaccineSiteEnum" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates the effective date of the insurance coverage. EndDate indicates the date when the coverage was terminated. | | |
| Comments | Free text string containing any comments related to this insurance document. | | |
| Provider | Identifies the Primary Care Provider (PCP) associated with this coverage, if applicable. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Insurance | |||
| Insurer | Identifies the textual description of the Insurer. | | |
| ContractId | Contains the complete Contract Identification number for the insurance, including all prefixes and suffixes. | | |
| GroupNumber | Contains the GroupNumber associated with the insurance. | | |
| Subscriber | Identifies the primary Subscriber for this insurance. | | |
| PlanName | Contains the textual description of the PlanName. | For example, Basic PPO. | |
| ProviderType | An attribute of the InsuranceType indicating the type of coverage associated with the insurer. | See values for InsuranceProviderTypeEnum in List.xsd. | |
Example XML
<phr:Insurance xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ProviderType="Primary Medical"
ProfessionallySourced="true"
xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
<phr:Address>
<phr:StreetAddress1>1 Longwood Ave</phr:StreetAddress1>
<phr:City>Boston</phr:City>
<phr:State>MA</phr:State>
</phr:Address>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>32445</phr:Identifier>
</phr:ProviderIdentifier>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<Insurer class="Organization">
<phr:Organization>
<phr:OrganizationName>Harvard Prigrim</phr:OrganizationName>
</phr:Organization>
</Insurer>
<ContractId>WLV0003434243R</ContractId>
<GroupNumber>4512122</GroupNumber>
<Subscriber class="Personal">
<phr:Individual>
<phr:FirstName>Jimmy</phr:FirstName>
<phr:LastName>Lampkin</phr:LastName>
<phr:DateOfBith>1950-03-26</phr:DateOfBith>
</phr:Individual>
</Subscriber>
<PlanName>HardvardPilgrim</PlanName>
</phr:Insurance>
LabTest
Contains information related to lab tests and lab results.
Source: http://www.dossia.org/v2.0/xml/phr/labTest.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/types.xsd"/>
<complexType name="LabTestType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Code" type="phr:StandardCodingSystemType"/>
<element name="Result" type="phr:StandardResultType"/>
<element name="Substance" type="phr:StandardCodingSystemType" minOccurs="0"/>
<element name="CollectionMethod" type="phr:StandardCodingSystemType" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates when the Test was ordered or when the result was reported - as indicated by the StartDate attribute Type. | See values for DurationTypeEnum in List.xsd. | |
| Comments | Free text string containing any comments related to this LabTest document. | | |
| Provider | Identifies the provider associated with Lab Test. If Date indicates "Scheduled" the Provider is the ordering/referring provider; if the Date indicates "Actual" the Provider is the laboratory provider. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| LabTest | |||
| LabTest | The textual description of the Test performed. | | |
| Code | Contains the exact code as identified in the Coding system | The preferred vocabulary is LOINC. See CodingSystem for extended elements. | |
| Result | Contains the value observed by the observation producer. | IMPORTANT: For test reslts that are expected to be graphed in the Dossia UI you MUST separate the value and the unit. For example, <value>120</value> <unit>mg/dL</unit> | |
| OrderedBy | Indicates the provider responsible for ordering the test when only the result record is provided. | NPI | |
| Substance | Indicates the substance that the result was obtained from. | | |
| CollectionMethod | Indicates the method used for collecting the substance. | | |
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<phr:LabTest xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
ProfessionallySourced="false">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Actual">
<phr:StartDate>1990-03-22</phr:StartDate>
</phr:Date>
<phr:Code MinorVersion="" MajorVersion="" System="LOINC">
<phr:Code>14743-9</phr:Code>
</phr:Code>
<phr:Result>
<phr:Value>126.0</phr:Value>
<phr:Unit MinorVersion="" MajorVersion="" System="UCUM">
<phr:Code>mg/dL</phr:Code>
</phr:Unit>
<phr:Status>Final</phr:Status>
</phr:Result>
</phr:LabTest>
Measurement
Contains information related to an individual's occupational, lifestyle, social, and other risk factors. Please note that this data type also contains information about an individual's vital signs, as well as any personal traits. For reference purposes we have included the LOINC codes that the Dossia UI uses for the following common measurments. Please refer to the measurment type enumerated list for all measurment types.
| Measurment | Material | LOINC Code | Unit of Measure |
| Glucose | |||
| Fasting Glucose Lab Test | Ser/Plas | 1558-6 | mg/dL |
| Non-Fasting Glucose Lab Test | Ser/Plas | 2345-7 | mg/dL |
| Fasting Glucose - Glucometer | Capillary | 41604-0 | mg/dL |
| Non-Fasting Glucose - Glucometer | Capillary | 41653-7 | mg/dL |
| HbA1c | Bld | 4548-4 | % |
| Cholesterol | |||
| HDL | Ser/Plas | 2085-9 | mg/dL |
| LDL | Ser/Plas | 18262-6 | mg/dL |
| Total | Ser/Plas | 2093-3 | mg/dL |
| Triglycerides | Ser/Plas | 2571-8 | mg/dL |
Source: http://www.dossia.org/v2.0/xml/phr/measurement.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/types.xsd"/>
<complexType name="MeasurementType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Active" type="phr:MeasurementResultType"/>
<element name="Prior" type="phr:MeasurementResultType" minOccurs="0"/>
</sequence>
<xsd:attribute name="class" type="phr:MeasurementTypeEnum" use="required"/>
</extension>
</complexContent>
</complexType>
<complexType name="MeasurementResultType">
<sequence>
<element ref="phr:MeasurementAbstractResult"/>
</sequence>
</complexType>
<element name="MeasurementAbstractResult" abstract="true"/>
<xsd:element name="MeasurementAnswer" type="phr:MeasurementAnswerType" substitutionGroup="phr:MeasurementAbstractResult"/>
<xsd:element name="BloodPressure" type="phr:BloodPressureType" substitutionGroup="phr:MeasurementAbstractResult"/>
<xsd:element name="LoincMeasurementResult" type="phr:LoincMeasurementResultType" substitutionGroup="phr:MeasurementAbstractResult"/>
<xsd:element name="DossiaResult" type="phr:DossiaResultType" substitutionGroup="phr:MeasurementAbstractResult"/>
<xsd:element name="PhysicalTrait" type="phr:PhysicalTraitType" substitutionGroup="phr:MeasurementAbstractResult"/>
<xsd:element name="PainMeasurementResult" type="phr:PainMeasurementResultType" substitutionGroup="phr:MeasurementAbstractResult"/>
<complexType name="MeasurementAnswerType">
<sequence>
<choice>
<element name="YesNo" type="boolean"/>
<element name="Frequency" type="phr:MeasurementFrequencyEnum"/>
</choice>
</sequence>
</complexType>
<complexType name="BloodPressureType">
<sequence>
<element name="Systolic" type="double" minOccurs="0"/>
<element name="Diastolic" type="double" minOccurs="0"/>
<element name="ReferenceRange" type="phr:DoubleRangeType" minOccurs="0"/>
</sequence>
</complexType>
<complexType name="PainMeasurementResultType">
<sequence>
<element name="PainScore" type="phr:DossiaMeasurementRangeType" minOccurs="0"/>
<element name="ActivityLevel" type="phr:DossiaMeasurementRangeType" minOccurs="0"/>
<element name="Mood" type="phr:MoodMeasurementResultType" minOccurs="0"/>
<element name="Duration" type="phr:DurationMeasurementType" minOccurs="0"/>
<element name="PainType" type="phr:PainType" minOccurs="0"/>
<element name="Trigger" type="phr:PainTriggerEnum" minOccurs="0" maxOccurs="unbounded"/>
<element name="MissedActivities" type="phr:PainMissedActivitiesType" minOccurs="0" maxOccurs="unbounded"/>
<element name="SideEffects" type="phr:PainSideEffectsType" minOccurs="0" maxOccurs="unbounded"/>
<element name="PainTeatment" type="phr:StandardCodingSystemType" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
<attribute name="AnatomicRegion" type="phr:AnatomicRegionEnum" use="optional"/>
<attribute name="AnatomicSide" type="phr:AnatomicSideEnum" use="optional"/>
</complexType>
<complexType name="MoodMeasurementResultType">
<sequence>
<choice>
<element name="Value" type="phr:MoodEnum"/>
<element name="Other" type="string"/>
</choice>
</sequence>
</complexType>
<complexType name="PainType">
<sequence>
<choice>
<element name="Value" type="phr:PainTypeEnum"/>
<element name="Other" type="string"/>
</choice>
</sequence>
</complexType>
<complexType name="PainMissedActivitiesType">
<sequence>
<choice>
<element name="Value" type="phr:PainMissedActivitiesEnum"/>
<element name="Other" type="string"/>
</choice>
</sequence>
</complexType>
<complexType name="PainSideEffectsType">
<sequence>
<choice>
<element name="Value" type="phr:PainSideEffectsEnum"/>
<element name="Other" type="string"/>
</choice>
</sequence>
</complexType>
<complexType name="LoincMeasurementResultType">
<sequence>
<element name="Value" type="double"/>
<element name="LoincResult" type="phr:StandardCodingSystemType"/>
</sequence>
</complexType>
<complexType name="DossiaResultType">
<sequence>
<choice>
<sequence>
<element name="Value" type="double"/>
<element name="Unit" type="phr:MeasurementAmountsEnum" minOccurs="0"/>
<element name="ReferenceRange" type="phr:DoubleRangeType" minOccurs="0"/>
</sequence>
<element name="TextValue" type="string" minOccurs="0"/>
</choice>
<element name="Status" type="phr:ResultStatusTypeEnum" minOccurs="0"/>
</sequence>
</complexType>
<complexType name="DossiaMeasurementRangeType">
<simpleContent>
<extension base="double">
<attribute name="RangeMin" type="double" use="required"/>
<attribute name="RangeMax" type="double" use="required"/>
</extension>
</simpleContent>
</complexType>
<complexType name="PhysicalTraitType">
<sequence>
<choice>
<element name="BloodType" type="phr:BloodTypeEnum"/>
<element name="HairColor" type="phr:HairColorEnum"/>
<element name="EyeColor" type="phr:EyeColorEnum"/>
<element name="Race" type="phr:EthnicRaceEnum"/>
</choice>
</sequence>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates when the measurement was taken. | | |
| Comments | Free text string containing any Comments related to this measurement details document. | | |
| Provider | Identifies the Provider who took the measurement. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Measurement | |||
| Active | | ||
| Prior | | ||
| Class | Indicates the type of measurement, risk factor, vital, or other measurable information. | See values for MeasurementTypeEnum in List.xsd. | |
| MeasurementAnswer | |||
| YesNo | | ||
| Frequency | How often is the measurement taken. | See values for MeasurementFrequencyEnum in List.xsd. | |
| BloodPressure | |||
| Systolic | Systolic Blood Pressure | | |
| Diastolic | Diastolic Blood Pressure | | |
| ReferenceRange | | ||
| PainMeasurementResultType | |||
| PainScore | A score of 1 to 10 indicating the intensity of the pain | | |
| Activity Level | An indication of the activity level | | |
| Mood | An indication of the person's mood | See values for MoodEnum in List.xsd. | |
| Duration | An indication of how long the pain lasted | See values for DurationMeasurementEnum in List.xsd. | |
| PainType | A classification of the type of pain | See values for PainTypeEnum in List.xsd. | |
| Trigger | Any particular activity or event that caused the on-set | See values for PainTriggerEnum in List.xsd. | |
| MissedActivities | Activities that were missed | See values for PainActivitiesMissedEnum in List.xsd. | |
| SideEffects | Side effects of the treatment | See values for PainSideEffectsEnum in List.xsd. | |
| PainTreatment | A description of the treatment provided for the episode of pain | | |
| AnatomicRegion | The location on the body where the pain exists | See values for AnatomicRegionEnum in List.xsd. | |
| AnatomicSide | Indication if pain is on the right or left side of the body | See values for AnatomicSideEnum in List.xsd. | |
| DossiaResult | |||
| Value | Value | | |
| Unit | Unit | See values for MeasurementAmountsEnum in List.xsd. | |
| ReferenceRange | Reference Range | | |
| TextValue | Text Value | | |
| Status | Status | See values for ResultStatusTypeEnum in List.xsd. | |
| PhysicalTrait | |||
| BloodType | Blood Type | See values for BloodTypeEnum in List.xsd. | |
| HairColor | Hair Color | See values for HairColorEnum in List.xsd. | |
| EyeColor | Eye Color | See values for EyeColorEnum in List.xsd. | |
| Race | Ethnic Race | See values for EthnicRaceEnum in List.xsd. | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Measurement xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" class="Hair Color" ProfessionallySourced="false" xsi:schemaLocation="http://www.dossia.org/v2.0/xml/phr http://www.dossia.org/v2.0/xml/phr/measurement.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Active xsi:type="phr:PhysicalTraitType">
<phr:HairColor>Red</phr:HairColor>
</phr:Active>
</phr:Measurement>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Measurement xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" class="Blood Pressure" ProfessionallySourced="false" xsi:schemaLocation="http://www.dossia.org/v2.0/xml/phr http://www.dossia.org/v2.0/xml/phr/measurement.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Active xsi:type="phr:BloodPressureType">
<phr:Systolic>120.0</phr:Systolic>
<phr:Diastolic>90.0</phr:Diastolic>
</phr:Active>
</phr:Measurement>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Measurement xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" class="Height" ProfessionallySourced="false" xsi:schemaLocation="http://www.dossia.org/v2.0/xml/phr http://www.dossia.org/v2.0/xml/phr/measurement.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Active xsi:type="phr:DossiaResultType">
<phr:Value>168.0</phr:Value>
<phr:Unit>Centimeters</phr:Unit>
<phr:Status>Final</phr:Status>
</phr:Active>
</phr:Measurement>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Measurement xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" class="Helmet" ProfessionallySourced="false" xsi:schemaLocation="http://www.dossia.org/v2.0/xml/phr http://www.dossia.org/v2.0/xml/phr/measurement.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Active xsi:type="phr:MeasurementAnswerType">
<phr:Frequency>Often</phr:Frequency>
</phr:Active>
</phr:Measurement>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Measurement xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" class="Cigarettes" ProfessionallySourced="false" xsi:schemaLocation="http://www.dossia.org/v2.0/xml/phr http://www.dossia.org/v2.0/xml/phr/measurement.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Active xsi:type="phr:MeasurementAnswerType">
<phr:YesNo>false</phr:YesNo>
</phr:Active>
<phr:Prior xsi:type="phr:DossiaResultType">
<phr:Value>7.0</phr:Value>
<phr:Unit>per week</phr:Unit>
<phr:Status>Final</phr:Status>
</phr:Prior>
</phr:Measurement>
Medications
The Medications schema contains 4 sets of data related to an individual and their Medications. This schema contains the following:
- Medication Details - The medication
- Medication Prescription Details - the data related to the actual prescription as provided by the provider.
- Medication - Fulfillment History - the data related to the filling/acquiring of the medication.
- Medication - Compliance - the data related to the actual taking of the drug.
Source: http://www.dossia.org/v2.0/xml/phr/medication.xsd
Prescription, Fulfillment and Compliance documents must be related to a Medication document. This can be achieved with with this API Call or by using the Container document, having the Medication as the main documents and using the related documents section for applicable child document.
Medication
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/types.xsd"/>
<complexType name="MedicationType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Drug" type="phr:MedicationCodingSystemType"/>
</sequence>
<attribute name="Prescription" type="boolean" use="required"/>
</extension>
</complexContent>
</complexType>
<complexType name="MedicationCodingSystemType">
<sequence>
<element name="Code" type="phr:StandardCodingSystemType"/>
<element name="Manufacturer" type="string" minOccurs="0" />
<element name="Form" type="string" minOccurs="0"/>
<element name="Route" type="string" minOccurs="0"/>
<element name="ActiveIngredients" type="phr:MedicationIngredientType" minOccurs="0" maxOccurs="unbounded"/>
<element name="Concentration" type="string" minOccurs="0"/>
</sequence>
</complexType>
<complexType name="MedicationIngredientType">
<sequence>
<element name="Strength" type="string" minOccurs="0"/>
<element name="Ingredient" type="string" minOccurs="0"/>
</sequence>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates when the prescription was Written. EndDate indicates when the written/ordered prescription expires (this is NOT the date the medication expires). | | |
| Comments | Free text string containing any Comments related to this measurement details document. | | |
| Provider | Identifies the Provider who wrote the prescription. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Medication | |||
| Drug | Is the container for the actual drug detail information. Note: the LBLCODE padded with zeros on the left and then concatenated to a four digit PRODCODE on the right. If the PRODCODE is 3 digits, it's also padded with a leading zero. | See MedicationCodingSystem under CodingSystem . | |
| Prescription | An attribute of the Drug indicating if the medication was prescribed. | | |
| Manufacturer | The Manufacturer of the Drug. | | |
| Form | The Form of the Drug. | | |
| Route | The Route of the Drug | | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Medication xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Prescription="false"
ProfessionallySourced="true"
xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>Blue Cross/Blue Shield of Arkansas
</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Drug>
<phr:Code MinorVersion="" MajorVersion="0" System="NDC">
<phr:Code>540920391</phr:Code>
</phr:Code>
<phr:Manufacturer>SHIRE US MANUFACTURING IN</phr:Manufacturer>
<phr:Form>Tablet</phr:Form>
<phr:Route>Oral</phr:Route>
</phr:Drug>
</phr:Medication>
Medication - Prescription Details
- PrescriptionDetails - the data related to the actual prescription as provided by the provider.
Source: http://www.dossia.org/v2.0/xml/phr/medication.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/types.xsd"/>
<complexType name="PrescriptionDetailsType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Pharmacy" type="phr:ActorType"/>
<element name="RxNumber" type="string"/>
<element name="PrescribedQuantity" type="integer"/>
<element name="DispenseInstructions" type="string" minOccurs="0" />
<element name="SubstitutionPermitted" type="boolean" minOccurs="0"/>
<element name="NumberOfRefills" type="integer" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional | |
|---|---|---|---|---|
| PersonalHealthData | ||||
| Origin | Indicates the individual or system that was the originating source for this information. | | ||
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates when the prescription was Written. EndDate indicates when the written/ordered prescription expires (this is NOT the date the medication expires). | | ||
| Comments | Free text string containing any Comments related to this measurement details document. | | ||
| Provider | Identifies the Provider who wrote the prescription. | | ||
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | | |
| PrescriptionDetails | ||||
| PrescribedQuantity | Quantity prescribed. | | ||
| DispenseInstructions | Dispense Instructions. | | ||
| SubstitutionPermit | Is substitution permitted. | | ||
| NumberOfRefills | Number of times this medication may be refilled. | | ||
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Prescription xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ProfessionallySourced="true" xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>Blue Cross/Blue Shield of Arkansas</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:PrescribedQuantity>30</phr:PrescribedQuantity>
<phr:DispenseInstructions>Dispense instrs</phr:DispenseInstructions>
<phr:SubstitutionPermitted>false</phr:SubstitutionPermitted>
<phr:NumberOfRefills>3</phr:NumberOfRefills>
</phr:Prescription>
Medication - Fulfillment History
- FulfillmentHistory - the data related to the prescription being filled.
Source: http://www.dossia.org/v2.0/xml/phr/medication.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/types.xsd"/>
<complexType name="FulfillmentHistoryType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Pharmacy" type="phr:ActorType" minOccurs="0"/>
<element name="RxNumber" type="string" minOccurs="0" />
<element name="FillSequenceNumber" type="integer" minOccurs="0"/>
<element name="FillQuantity" type="double" minOccurs="0"/>
<element name="FillUnit" type="string" minOccurs="0"/>
<element name="RefillsRemaining" type="integer" minOccurs="0"/>
<element name="PatientInstructions" type="string" minOccurs="0" />
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates when the prescription was filled by the pharmacist. EndDate indicates when the patient picked-up the prescription. | | |
| Comments | Free text string containing any Comments related to this measurement details document. | | |
| Provider | Identifies the provider who wrote the prescription. | Will be the same as the Provider in the PrescriptionDetails. | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. |
|
| FullfillmentHistory | |||
| Pharmacy | Identifies the Pharmacy who filled this prescription. | NCPDP | |
| RxNumber | Pharmacy Rx number - must be made unique across data sources by adding the NCPDP as a prefix. | | |
| FillSequenceNumber | Fill sequence number | | |
| FillQuantity | Actual quantity filled | | |
| PatientInstructions | Patient Instructions. | | |
| RefillsRemaining | Number of refills remaining not including the current fulfillment record. | | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:MedicationFulfillment xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ProfessionallySourced="true" xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>Blue Cross/Blue Shield of Arkansas</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
<phr:EndDate>1999-05-26</phr:EndDate>
</phr:Date>
<phr:Pharmacy class="Organization">
<phr:Organization>
<phr:OrganizationName>Caremark</phr:OrganizationName>
<phr:Address>
<phr:StreetAddress1>21 Longwood Ave</phr:StreetAddress1>
<phr:City>Boston</phr:City>
<phr:State>MA</phr:State>
</phr:Address>
<phr:ProviderIdentifier Type="NCPDP">
<phr:Identifier>324234</phr:Identifier>
</phr:ProviderIdentifier>
</phr:Organization>
</phr:Pharmacy>
<phr:RxNumber>345234532453</phr:RxNumber>
<phr:FillSequenceNumber>1</phr:FillSequenceNumber>
<phr:FillQuantity>30.0</phr:FillQuantity>
<phr:FillUnit>tablets</phr:FillUnit>
<phr:RefillsRemaining>2</phr:RefillsRemaining>
<phr:PatientInstructions>take twice daily, an hour before food</phr:PatientInstructions>
</phr:MedicationFulfillment>
Medication - Compliance
- Compliance - the data related to the medication being taken by the individual.
Source: http://www.dossia.org/v2.0/xml/phr/medication.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/types.xsd"/>
<complexType name="ComplianceType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="DoseTaken" type="string" minOccurs="0"/>
<element name="Route" type="string" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates when the medication was taken. If the medication requires a duration (ie, IV antibiotics) an EndDate can be populated. | | |
| Comments | Free text string containing any Comments related to this compliance document. | | |
| Provider | NA | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| ComplianceHistory | |||
| DoseTaken | Indicates the dose that was taken. | | |
| Route | Indicates the route the medication was given/taken. | | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:MedicationCompliance xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ProfessionallySourced="true" xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>Blue Cross/Blue Shield of Arkansas</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
<phr:StartTime>15:25:00.000-04:00</phr:StartTime>
</phr:Date>
<phr:DoseTaken>100 mg</phr:DoseTaken>
<phr:Route>route</phr:Route>
</phr:MedicationCompliance>
Micro
http://www.dossia.org/v2.0/xml/phr/micro.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/labTest.xsd"/>
<complexType name="MicrobiologyType">
<complexContent>
<extension base="phr:LabTestType">
<sequence>
<element name="Sensitivity" type="phr:SensitivityType" minOccurs="0" maxOccurs="unbounded"/>
<element name="SpecimenType" type="string" minOccurs="0"/>
<element name="OrganismName" type="string" minOccurs="0"/>
<element name="OrganismComment" type="string" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="SensitivityType">
<sequence>
<element name="Agent" type="string" minOccurs="1"/>
<element name="Value" type="string" minOccurs="1"/>
<element name="Interpretation" type="string" minOccurs="1"/>
</sequence>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| Microbiology | |||
| Sensitivity | Indicates the sensitivity of the information. | | |
| SpecimenType | Indicates the type of specimen. | | |
| OrganismName | Contains the name of the Organism. | | |
| OrganismComment | Free text comment related to this document. | | |
| Sensitivity | |||
| Agent | Indicates the agent. | | |
| Value | Indicates the value. | | |
| Interpretation | Contains the interpretation. | | |
Example XML
<phr:Microbiology xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ProfessionallySourced="true" xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="PHR">
<phr:Organization>
<phr:OrganizationName>Dossia</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Code MinorVersion="" MajorVersion="" System="LOINC">
<phr:Code>code</phr:Code>
<phr:ShortDescription>blood</phr:ShortDescription>
</phr:Code>
<phr:Result>
<phr:TextValue>Text Example of result</phr:TextValue>
<phr:Status>Final</phr:Status>
</phr:Result>
<phr:Substance MinorVersion="" MajorVersion="" System="LOINC">
<phr:Code>code</phr:Code>
<phr:ShortDescription>substance</phr:ShortDescription>
</phr:Substance>
<phr:CollectionMethod MinorVersion="" MajorVersion="" System="LOINC">
<phr:Code>code</phr:Code>
<phr:ShortDescription>needle</phr:ShortDescription>
</phr:CollectionMethod>
<phr:Sensitivity>
<phr:Agent>agent</phr:Agent>
<phr:Value>value</phr:Value>
<phr:Interpretation>interpretation</phr:Interpretation>
</phr:Sensitivity>
<phr:OrganismName>organismName</phr:OrganismName>
</phr:Microbiology>
PersonalHealthData
Contains the information common to many data types. We have intentionally included the PersonalHealthData elements in other schemas that extend this type. For clarity these elements are defined to assist in the appropriate use and to minimize incorrect or differing interpretations.
http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/types.xsd"/>
<complexType name="PersonalHealthDataType" abstract="true">
<sequence>
<element name="Origin" type="phr:OriginType"/>
<element name="Provider" type="phr:ActorType" minOccurs="0"/>
<element name="SecondaryProvider" type="phr:ActorType" minOccurs="0" maxOccurs="unbounded"/>
<element name="Date" type="phr:DurationType"/>
<element name="Comments" type="string" minOccurs="0"/>
</sequence>
<attribute name="ProfessionallySourced" type="boolean" use="required"/>
</complexType>
<complexType name="OriginType">
<sequence>
<element name="Organization" type="phr:OrganizationType" minOccurs="0"/>
</sequence>
<attribute name="Classification" type="phr:ClassificationEnumType" use="required"/>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The date as a DurationType allows a Start and an End date.
StartDate indicates when an activity or event occurred or started. EndDate indicates when the activity or event ended or stopped. A single point in time can be indicated by not including an EndDate or by making the StartDate and EndDate identical. Please see each datatype that extends the PersonalHealthData type for related usage. | | |
| Comments | Free text string containing any Comments related to the related document. | | |
| Provider | Identifies the Provider who is associated with the document. Please see each datatype that extends the PersonalHealthData type for related usage. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | Boolean Flag. False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
Problem
Contains information about an individual's relevant current and historical clinical problems, conditions, symptoms, findings, and complaints. Professionally sourced diagnosis are typically related to an encounter.
Source: http://www.dossia.org/v2.0/xml/phr/problem.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="ProblemType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Code" type="phr:StandardCodingSystemType"/>
<element name="Status" type="phr:StatusEnum" minOccurs="0"/>
<element name="Sensitive" type="boolean" minOccurs="0"/>
</sequence>
<attribute name="sequence" type="positiveInteger" use="required"/>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date as a DurationType allows a Start and an End date.
StartDate indicates when the problem/condition was first observed or a diagnosis was first made. EndDate indicates when the problem/condition was no longer occuring. A single point in time can be indicated by not including and EndDate or by making the StartDate and EndDate identical. | | |
| Comments | Free text string containing any Comments related to the related document. | | |
| Provider | Identifies the Provider responsible for making the diagnosis. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | Boolean Flag. False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Problem | |||
| Code | Diagnosis Code for the patient's condition. Note: do not include the "period" (dot) in the code. | The preferred vocabulary is ICD or SNOMED. See CodingSystem for extended elements. | |
| Status | Defines the Status of the Problem. | See Status StatusEnum enumerated listing in Lists.xsd. | |
| Sensitive | If professionally sourced, pre-consultation release of this item to patient is not desired. | Yes/No | |
| Sequence | Indicates the order of the element within an encounter. For example, sequence 1 is the primary. | | |
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<phr:Problem xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" sequence="1" ProfessionallySourced="true" xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>Blue Cross/Blue Shield of Arkansas</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Approximate">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Code MinorVersion="0" MajorVersion="9" System="ICD">
<phr:Code>123</phr:Code>
</phr:Code>
<phr:Status>Active</phr:Status>
</phr:Problem>
Procedure
Contains information about an individual's interventional, surgical, diagnostic, or therapeutic procedures, treatments, and health related services. The preferred controlled vocabulary is CPT, HCPCS, ICD, and SNOMED CT for procedures and LOINC for any results. Professionally sourced procedures are typically related to an encounter.
Source: http://www.dossia.org/v2.0/xml/phr/procedure.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr" xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/personalHealthData.xsd"/>
<complexType name="ProcedureType">
<complexContent>
<extension base="phr:PersonalHealthDataType">
<sequence>
<element name="Code" type="phr:StandardCodingSystemType"/>
</sequence>
<attribute name="sequence" type="positiveInteger" use="required"/>
</extension>
</complexContent>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional |
|---|---|---|---|
| PersonalHealthData | |||
| Origin | Indicates the individual or system that was the originating source for this information. | | |
| Date | The Date as a DurationType allows a Start and an End date.
StartDate when the procedure started. EndDate indicates when the procedure ended or stopped. A single point in time can be indicated by not including and EndDate or by making the StartDate and EndDate identical. | | |
| Comments | Free text string containing any Comments related to the related document. | | |
| Provider | Identifies the Provider who performed the procedure, treatment, or service. | | |
| ProfessionallySourced | An attribute of the PersonalHealthDataType indicating whether the information came from a codified source or if the information was self-entered. | Boolean Flag. False if the information was self-entered. If unknown then False. | |
| Classification | An attribute of the OriginType indicating a Classification of the source of data. | See values for ClassificationEnumType in List.xsd. | |
| Procedure | |||
| Provider | Identifies the provider who performed the procedure, treatment, or service. | | |
| Code | Procedure Code identifying the procedure, treatment, or service. | See CodingSystem for extended elements. HCPCS refer to the CMS coding system. | |
| Sequence | Indicates the order of the element within an encounter. For example, sequence 1 is the primary. | | |
Example XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<phr:Procedure xmlns:phr="http://www.dossia.org/v2.0/xml/phr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" sequence="1" ProfessionallySourced="true" xsi:schemaLocation="http://www.dossia.org/v2.0/api/ http://www.dossia.org/v2.0/api/container.xsd">
<phr:Origin Classification="Claims Medical">
<phr:Organization>
<phr:OrganizationName>Blue Cross/Blue Shield of Arkansas</phr:OrganizationName>
</phr:Organization>
</phr:Origin>
<phr:Provider class="Medical Professional">
<phr:Individual>
<phr:FullName>Dr Samuel Geddis</phr:FullName>
<phr:ProviderIdentifier Type="NPI">
<phr:Identifier>1215156</phr:Identifier>
</phr:ProviderIdentifier>
<phr:Organization>
<phr:OrganizationName>Harvard Vanguard</phr:OrganizationName>
</phr:Organization>
</phr:Individual>
</phr:Provider>
<phr:Date Type="Actual">
<phr:StartDate>1999-05-26</phr:StartDate>
</phr:Date>
<phr:Code MinorVersion="0" MajorVersion="9" System="CPT">
<phr:Code>123</phr:Code>
</phr:Code>
</phr:Procedure>
Types
http://www.dossia.org/v2.0/xml/phr/types.xsd
Data Type Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.dossia.org/v2.0/xml/phr"
xmlns:phr="http://www.dossia.org/v2.0/xml/phr"
xmlns:dosxml="http://www.dossia.org/v2.0/xml"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<include schemaLocation="http://www.dossia.org/v2.0/xml/phr/codingSystem.xsd"/>
<complexType name="ActorType">
<sequence>
<choice>
<element name="Individual" type="phr:IndividualType" minOccurs="0"/>
<element name="Organization" type="phr:OrganizationType" minOccurs="0"/>
</choice>
</sequence>
<xsd:attribute name="class" type="phr:ActorTypeEnum" use="required"/>
<xsd:attribute name="role" type="phr:ClinicalProviderRoleTypeEnum" use="optional"/>
</complexType>
<complexType name="ParticipantType">
<xsd:complexContent>
<xsd:extension base="phr:PersonType">
<xsd:attribute name="type" type="phr:ParticipantTypeEnum"/>
</xsd:extension>
</xsd:complexContent>
</complexType>
<complexType name="IndividualType">
<xsd:complexContent>
<xsd:extension base="phr:PersonType">
<sequence>
<element name="ProviderIdentifier" type="phr:ProviderIdentifierType" minOccurs="0"/>
<element name="Organization" type="phr:OrganizationType" minOccurs="0"/>
<element name="HealthStatus" type="phr:HealthStatusType" minOccurs="0"/>
</sequence>
<xsd:attribute name="ProviderType" type="phr:ProviderDescriptionEnum" use="optional"/>
<xsd:attribute name="PersonRelationshipType" type="phr:PersonRelationshipTypeEnum" use="optional"/>
</xsd:extension>
</xsd:complexContent>
</complexType>
<complexType name="PersonType">
<sequence>
<element name="FullName" type="string" minOccurs="0"/>
<element name="Prefix" type="string" minOccurs="0"/>
<element name="FirstName" type="string" minOccurs="0"/>
<element name="MiddleName" type="string" minOccurs="0"/>
<element name="LastName" type="string" minOccurs="0"/>
<element name="Suffix" type="string" minOccurs="0"/>
<element name="DateOfBith" type="date" minOccurs="0"/>
<element name="Gender" type="phr:GenderEnum" minOccurs="0"/>
<element name="Address" type="phr:AddressType" minOccurs="0"/>
<element name="Contact" type="phr:ContactType" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
<complexType name="OrganizationType">
<sequence>
<element name="OrganizationName" type="string"/>
<element name="Address" type="phr:AddressType" minOccurs="0"/>
<element name="Contact" type="phr:ContactType" minOccurs="0" maxOccurs="unbounded"/>
<element name="ProviderIdentifier" type="phr:ProviderIdentifierType" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
<xsd:attribute name="ProviderType" type="phr:ProviderOrganizationDescriptionEnum" use="optional"/>
</complexType>
<complexType name="AddressType">
<sequence>
<element name="StreetAddress1" type="string"/>
<element name="StreetAddress2" type="string" minOccurs="0"/>
<element name="County" type="string" minOccurs="0"/>
<element name="City" type="string"/>
<element name="State" type="string" minOccurs="0"/>
<element name="PostalCode" type="string" minOccurs="0"/>
<element name="Country" type="string" minOccurs="0"/>
</sequence>
</complexType>
<complexType name="ProviderIdentifierType">
<sequence>
<element name="Identifier" type="string"/>
<element name="Description" type="string" minOccurs="0" />
</sequence>
<attribute name="Type" type="phr:ProviderIdentifierEnum" use="required" />
</complexType>
<complexType name="ContactType">
<simpleContent>
<extension base="string">
<attribute name="type" type="phr:ContactEnum"/>
</extension>
</simpleContent>
</complexType>
<complexType name="DurationType">
<sequence>
<sequence>
<element name="StartDate" type="date" minOccurs="1" />
<element name="StartTime" type="time" minOccurs="0" />
<element name="EndDate" type="date" minOccurs="0" />
<element name="EndTime" type="time" minOccurs="0" />
</sequence>
</sequence>
<attribute name="Type" type="phr:DurationTypeEnum" use="required"/>
</complexType>
<complexType name="DurationMeasurementType">
<simpleContent>
<extension base="double">
<attribute name="Type" type="phr:DurationMeasurementTypeEnum" use="required"/>
</extension>
</simpleContent>
</complexType>
<complexType name="StandardResultType">
<sequence>
<choice>
<sequence>
<element name="Value" type="double"/>
<element name="Unit" type="phr:StandardCodingSystemType" minOccurs="0"/>
</sequence>
<element name="TextValue" type="string"/>
</choice>
<element name="ReferenceRange" type="phr:DoubleRangeType" minOccurs="0"/>
<element name="Status" type="phr:ResultStatusTypeEnum" minOccurs="0"/>
</sequence>
</complexType>
<complexType name="DoubleRangeType">
<sequence>
<choice>
<sequence>
<element name="Minimum" type="double"/>
<element name="Maximum" type="double"/>
</sequence>
<element name="TextRange" type="string" minOccurs="0"/>
</choice>
</sequence>
</complexType>
<complexType name="HealthStatusType">
<sequence>
<element name="HealthStatus" type="phr:HealthStatusEnum"/>
<element name="DateOfDeath" type="date" minOccurs="0"/>
<element name="CauseOfDeath" type="phr:StandardCodingSystemType" minOccurs="0"/>
</sequence>
</complexType>
</schema>
Data Element Definitions
| Element | Description | Notes | Required/Optional
|
|---|---|---|---|
| Actor | |||
| Individual | | ||
| Participant | | ||
| Organization | | ||
| Individual | | ||
| Organization | | ||
| ParticipantType | |||
| Type | See values for ParticipantTypeEnum in List.xsd. | | |
| IndividualType | |||
| ProviderIdentifier | | ||
| Taxonomy | | ||
| Organization | | ||
| ProviderType | See values for ProviderDescriptionEnum in List.xsd. | | |
| PersonType | |||
| FullName | | ||
| Prefix | | ||
| FirstName | | ||
| MiddleName | | ||
| LastName | | ||
| Suffix | | ||
| DateOfBirth | | ||
| Gender | See values for GenderEnum in List.xsd. | | |
| Address | | ||
| Contact | | ||
| OrganizationType | |||
| OrganizationName | | ||
| Address | | ||
| ProviderIdentifier | | ||
| AddressType | |||
| StreetAddress1 | | ||
| StreetAddress2 | | ||
| County | | ||
| City | | ||
| State | | ||
| PostalCode | | ||
| Country | | ||
| ProviderIdentifierType | |||
| Identifier | | ||
| Description | | ||
| Type | See values for ProviderIdentifierEnum in List.xsd. | | |
| ContactType | |||
| Type | See values for ContactEnum in List.xsd. | | |
| DurationType | |||
| StartDate | | ||
| EndDate | | ||
| Type | See values for DurationTypeEnum in List.xsd. | | |
| StandardResultType | |||
| Value | | ||
| Unit | | ||
| ReferenceRange | | ||
| TextValue | | ||
| Status | See values for ResultStatusTypeEnum in List.xsd. | | |
| DoubleRangeType | |||
| Minimum | | ||
| Maximum | | ||
| Unit | | ||
