This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Example Index:
Simple Example of a Composition | XML | JSON |
Example of a discharge summary | XML | JSON |
XML
Simple Example of a Composition (id = "example")
<Composition xmlns="http://hl7.org/fhir"> <id value="example"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <identifier> <system value="http://healthintersections.com.au/test"/> <value value="1"/> </identifier> <date value="2012-01-04T09:10:14Z"/> <type> <coding> <system value="http://loinc.org"/> <code value="11488-4"/> <display value="Consult note"/> </coding> </type> <status value="final"/> <confidentiality> <system value="http://ihe.net/xds/connectathon/confidentialityCodes"/> <code value="1.3.6.1.4.1.21367.2006.7.101"/> <display value="Clinical-Staff"/> </confidentiality> <subject> <reference value="Patient/xcda"/> <display value="Henry Levin the 7th"/> </subject> <author> <reference value="Practitioner/xcda-author"/> <display value="Robert Dolin MD"/> </author> <attester> <mode value="legal"/> <party> <reference value="Practitioner/xcda-author"/> <display value="Robert Dolin MD"/> </party> </attester> <custodian> <reference value="Organization/2.16.840.1.113883.19.5"/> <display value="Good Health Clinic"/> </custodian> <section> <title value="History of present illness"/> <content> <reference value="MedicationAdministration/example"/> </content> </section> </Composition>
JSON
Simple Example of a Composition
{ "resourceType": "Composition", "id": "example", "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "identifier": { "system": "http://healthintersections.com.au/test", "value": "1" }, "date": "2012-01-04T09:10:14Z", "type": { "coding": [ { "system": "http://loinc.org", "code": "11488-4", "display": "Consult note" } ] }, "status": "final", "confidentiality": { "system": "http://ihe.net/xds/connectathon/confidentialityCodes", "code": "1.3.6.1.4.1.21367.2006.7.101", "display": "Clinical-Staff" }, "subject": { "reference": "Patient/xcda", "display": "Henry Levin the 7th" }, "author": [ { "reference": "Practitioner/xcda-author", "display": "Robert Dolin MD" } ], "attester": [ { "mode": [ "legal" ], "party": { "reference": "Practitioner/xcda-author", "display": "Robert Dolin MD" } } ], "custodian": { "reference": "Organization/2.16.840.1.113883.19.5", "display": "Good Health Clinic" }, "section": [ { "title": "History of present illness", "content": { "reference": "MedicationAdministration/example" } } ] }
XML
Example of a discharge summary (id = "father")
<Bundle xmlns="http://hl7.org/fhir"> <id value="father"/> <meta> <lastUpdated value="2013-05-28T22:12:21Z"/> <tag> <system value="http://hl7.org/fhir/tag"/> <code value="document"/> </tag> </meta> <type value="document"/> <base value="http://fhir.healthintersections.com.au/open"/> <!-- The Composition resource --> <entry> <base value="urn:uuid:"/> <resource> <Composition> <id value="180f219f-97a8-486d-99d9-ed631fe4fc57"/> <meta> <lastUpdated value="2013-05-28T22:12:21Z"/> </meta> <date value="2013-02-01T12:30:02Z"/> <type> <coding> <system value="www.loinc.org"/> <code value="28655-9"/> </coding> <text value="Discharge Summary from Responsible Clinician"/> </type> <status value="final"/> <confidentiality> <system value="www.nz.org"/> <code value="1234-5"/> <display value="Normal"/> </confidentiality> <subject> <reference value="http://fhir.healthintersections.com.au/open/Patient/d1"/> <display value="Eve Everywoman"/> </subject> <author> <reference value="Practitioner/example"/> <display value="Doctor Dave"/> </author> <!-- The Encounter resource. Points directly to an Encounter resource. Contains the dates of admission, specialtyu etc. --> <section> <title value="Encounter Information"/> <content> <reference value="http://fhir.healthintersections.com.au/open/Encounter/doc-example"/> </content> </section> <section> <title value="Reason for admission"/> <content> <reference value="urn:uuid:d0dd51d3-3ab2-4c84-b697-a630c3e40e7a"/> </content> </section> <!-- Points to the list that groups the medications on discharge --> <section> <title value="Medications on Discharge"/> <content> <reference value="urn:uuid:673f8db5-0ffd-4395-9657-6da00420bbc1"/> </content> </section> <!-- Points to the list that groups the allergies --> <section> <title value="Known allergies"/> <content> <reference value="urn:uuid:68f86194-e6e1-4f65-b64a-5314256f8d7b"/> </content> </section> </Composition> </resource> </entry> <!-- The Practitioner Resource. In this document they are the author of the document (There is a reference from the document resource). Note that, strictly, it doesn't need to be within the document as the recipient knows where to go and get it if they need it - assuming it is available on-line of course. --> <entry> <resource> <Practitioner> <id value="doc-example"/> <meta> <lastUpdated value="2013-05-05T16:13:03Z"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <name> <text value="Doctor Dave"/> </name> </Practitioner> </resource> </entry> <!-- The Patient who is the subject of the document. Same coments as practitioner. --> <entry> <resource> <Patient> <id value="d1"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <identifier> <system value="nhi"/> </identifier> <name> <text value="Eve Everywoman"/> <family value="Everywoman1"/> <given value="Eve"/> </name> <telecom> <system value="phone"/> <value value="555-555-2003"/> <use value="work"/> </telecom> <gender value="female"/> <birthDate value="1955-01-06"/> <address> <use value="home"/> <line value="2222 Home Street"/> </address> <active value="true"/> </Patient> </resource> </entry> <!-- The encounter that is being documented. --> <entry> <resource> <Encounter> <id value="doc-example"/> <meta> <lastUpdated value="2013-05-05T16:13:03Z"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <identifier> <value value="S100"/> </identifier> <status value="finished"/> <class value="inpatient"/> <type> <text value="Orthopedic Admission"/> </type> <patient> <reference value="Patient/d1"/> </patient> <period> <start value="2013-01-20T12:30:02Z"/> <end value="2013-02-01T12:30:02Z"/> </period> <hospitalization> <dischargeDisposition> <text value="Discharged to care of GP"/> </dischargeDisposition> </hospitalization> </Encounter> </resource> </entry> <!-- The Reason for admission. --> <entry> <base value="urn:uuid:"/> <resource> <Observation> <id value="d0dd51d3-3ab2-4c84-b697-a630c3e40e7a"/> <meta> <lastUpdated value="2013-05-05T16:13:03Z"/> </meta> <text> <status value="additional"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <code> <coding> <system value="http://loinc.org"/> <code value="46241-6"/> </coding> <text value="Reason for admission"/> </code> <valueString value="Acute Asthmatic attack. Was wheezing for days prior to admission."/> <status value="final"/> <reliability value="ok"/> </Observation> </resource> </entry> <!-- The list of medications on discharge --> <entry> <base value="urn:uuid:"/> <resource> <List> <id value="673f8db5-0ffd-4395-9657-6da00420bbc1"/> <meta> <lastUpdated value="2013-05-05T16:13:03Z"/> </meta> <text> <status value="additional"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <code> <coding> <system value="http://loinc.org"/> <code value="10183-2"/> <display value="Hospital discharge medications"/> </coding> </code> <mode value="working"/> <!-- This is an entry that refers to a MedicationPrescription resource in this document. It is a new medication (as indicated by the flag) --> <entry> <flag> <coding> <!-- The flag refers to the valueset containing permissable codes for changes to medication status that occurred during this encounter. Possible values are started, continued, stopped, changed --> <system value="http://www.ithealthboard.health.nz/fhir/ValueSet/medicationStatus"/> <code value="started"/> </coding> </flag> <item> <reference value="urn:uuid:124a6916-5d84-4b8c-b250-10cefb8e6e86"/> </item> </entry> <!-- This is an entry that refers to a medicationPrescription that is available on an external server. In practice, you may still want an entry in the document as well, but it's not necessary. The medication was stopped on this admission. Note that the deleted element is also true. Because the resource is no longer active, we assume that it was deleted on the server, so following the link would result in an http status code of 410 (Though you can always use the history to get previous versions) --> <entry> <flag> <coding> <system value="http://www.ithealthboard.health.nz/fhir/ValueSet/medicationStatus"/> <code value="stopped"/> </coding> </flag> <deleted value="true"/> <item> <reference value="MedicationPrescription/1"/> <display value="use of Ventolin Inhaler was discontinued"/> </item> </entry> </List> </resource> </entry> <!-- The first medication in the medications list --> <entry> <base value="urn:uuid:"/> <resource> <MedicationPrescription> <id value="124a6916-5d84-4b8c-b250-10cefb8e6e86"/> <meta> <lastUpdated value="2013-05-05T16:13:03Z"/> </meta> <!-- The Human readible version of the script --> <text> <status value="generated"/> <!-- This text section can be exctly the same as CDA --> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <!-- The medication. This is currently modelled as a contained resource within the prescription, but could also be a separate resource either within the document bundle, or a reference to the medication on a server. The latter (i.e. where the medication terminology is hosted on a publically available server and simply referenced from the MedicationPrescription resource is particularly attractive... --> <contained> <Medication> <id value="med1"/> <name value="Theophylline 200mg"/> <code> <coding> <system value="http:/snomed.org"/> <code value="66493003"/> </coding> </code> </Medication> </contained> <!-- The patient details will generally be in the Document resource in the Document bundle, but could just as easily point to a patient resource on a server --> <patient> <reference value="http://fhir.healthintersections.com.au/open/Patient/d1"/> <display value="Peter Patient"/> </patient> <!-- The prescriber details could also be within the bundle, but has the same options as patient --> <prescriber> <reference value="Practitioner/example"/> <display value="Peter Practitioner"/> </prescriber> <reasonCodeableConcept> <text value="Management of Asthma"/> </reasonCodeableConcept> <!-- a reference to the medication being prescribed. As described earlier, this could be contained (as is the example here), separately within the document bundle or simply a reference to a remote server. See comment in the contained resource --> <medication> <reference value="Medication/example"/> <display value="Theophylline 200mg BD"/> </medication> <dosageInstruction> <additionalInstructions> <text value="Take with Food"/> </additionalInstructions> <!-- twice a day --> <scheduledTiming> <repeat> <frequency value="2"/> <duration value="1"/> <units value="d"/> </repeat> </scheduledTiming> <!-- Orally --> <route> <coding> <system value="http://snomed.info/sct"/> <code value="394899003"/> <display value="oral administration of treatment"/> </coding> </route> <doseQuantity> <value value="1"/> <units value="tablet"/> <system value="http://unitsofmeasure.org"/> <code value="tbl"/> </doseQuantity> </dosageInstruction> </MedicationPrescription> </resource> </entry> <!-- The list of known allergies --> <entry> <base value="urn:uuid:"/> <resource> <List> <id value="68f86194-e6e1-4f65-b64a-5314256f8d7b"/> <meta> <lastUpdated value="2013-05-05T16:13:03Z"/> </meta> <text> <status value="additional"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <code> <coding> <system value="http://loinc.org"/> <code value="48765-2"/> <display value="Allergies and adverse reactions Document"/> </coding> </code> <mode value="working"/> <!-- This is an entry that refers to an allergy resource in this document. --> <entry> <item> <reference value="urn:uuid:47600e0f-b6b5-4308-84b5-5dec157f7637"/> </item> </entry> </List> </resource> </entry> <!-- The Allergy. --> <entry> <base value="urn:uuid:"/> <resource> <AllergyIntolerance> <id value="47600e0f-b6b5-4308-84b5-5dec157f7637"/> <meta> <lastUpdated value="2013-05-05T16:13:03Z"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <recordedDate value="2012-09-17"/> <subject> <reference value="http://fhir.healthintersections.com.au/open/Patient/d1"/> <display value="Eve Everywoman"/> </subject> <substance> <text value="Doxycycline"/> </substance> <status value="confirmed"/> <criticality value="high"/> <type value="immune"/> <event> <manifestation> <coding> <system value="sys"/> <code value="xxx"/> <display value="Hives"/> </coding> <text value="Hives"/> </manifestation> </event> </AllergyIntolerance> </resource> </entry> </Bundle>
JSON
Example of a discharge summary
{ "resourceType": "Bundle", "id": "father", "meta": { "lastUpdated": "2013-05-28T22:12:21Z", "tag": [ { "system": "http://hl7.org/fhir/tag", "code": "document" } ] }, "type": "document", "base": "http://fhir.healthintersections.com.au/open", "entry": [ { "base": "urn:uuid:", "resource": { "resourceType": "Composition", "id": "180f219f-97a8-486d-99d9-ed631fe4fc57", "meta": { "lastUpdated": "2013-05-28T22:12:21Z" }, "date": "2013-02-01T12:30:02Z", "type": { "coding": [ { "system": "www.loinc.org", "code": "28655-9" } ], "text": "Discharge Summary from Responsible Clinician" }, "status": "final", "confidentiality": { "system": "www.nz.org", "code": "1234-5", "display": "Normal" }, "subject": { "reference": "http://fhir.healthintersections.com.au/open/Patient/d1", "display": "Eve Everywoman" }, "author": [ { "reference": "Practitioner/example", "display": "Doctor Dave" } ], "section": [ { "title": "Encounter Information", "content": { "reference": "http://fhir.healthintersections.com.au/open/Encounter/doc-example" } }, { "title": "Reason for admission", "content": { "reference": "urn:uuid:d0dd51d3-3ab2-4c84-b697-a630c3e40e7a" } }, { "title": "Medications on Discharge", "content": { "reference": "urn:uuid:673f8db5-0ffd-4395-9657-6da00420bbc1" } }, { "title": "Known allergies", "content": { "reference": "urn:uuid:68f86194-e6e1-4f65-b64a-5314256f8d7b" } } ] } }, { "resource": { "resourceType": "Practitioner", "id": "doc-example", "meta": { "lastUpdated": "2013-05-05T16:13:03Z" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "name": { "text": "Doctor Dave" } } }, { "resource": { "resourceType": "Patient", "id": "d1", "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "identifier": [ { "system": "nhi" } ], "name": [ { "text": "Eve Everywoman", "family": [ "Everywoman1" ], "given": [ "Eve" ] } ], "telecom": [ { "system": "phone", "value": "555-555-2003", "use": "work" } ], "gender": "female", "birthDate": "1955-01-06", "address": [ { "use": "home", "line": [ "2222 Home Street" ] } ], "active": true } }, { "resource": { "resourceType": "Encounter", "id": "doc-example", "meta": { "lastUpdated": "2013-05-05T16:13:03Z" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "identifier": [ { "value": "S100" } ], "status": "finished", "class": "inpatient", "type": [ { "text": "Orthopedic Admission" } ], "patient": { "reference": "Patient/d1" }, "period": { "start": "2013-01-20T12:30:02Z", "end": "2013-02-01T12:30:02Z" }, "hospitalization": { "dischargeDisposition": { "text": "Discharged to care of GP" } } } }, { "base": "urn:uuid:", "resource": { "resourceType": "Observation", "id": "d0dd51d3-3ab2-4c84-b697-a630c3e40e7a", "meta": { "lastUpdated": "2013-05-05T16:13:03Z" }, "text": { "status": "additional", "div": "<div>!-- Snipped for Brevity --></div>" }, "code": { "coding": [ { "system": "http://loinc.org", "code": "46241-6" } ], "text": "Reason for admission" }, "valueString": "Acute Asthmatic attack. Was wheezing for days prior to admission.", "status": "final", "reliability": "ok" } }, { "base": "urn:uuid:", "resource": { "resourceType": "List", "id": "673f8db5-0ffd-4395-9657-6da00420bbc1", "meta": { "lastUpdated": "2013-05-05T16:13:03Z" }, "text": { "status": "additional", "div": "<div>!-- Snipped for Brevity --></div>" }, "code": { "coding": [ { "system": "http://loinc.org", "code": "10183-2", "display": "Hospital discharge medications" } ] }, "mode": "working", "entry": [ { "flag": [ { "coding": [ { "system": "http://www.ithealthboard.health.nz/fhir/ValueSet/medicationStatus", "code": "started" } ] } ], "item": { "reference": "urn:uuid:124a6916-5d84-4b8c-b250-10cefb8e6e86" } }, { "flag": [ { "coding": [ { "system": "http://www.ithealthboard.health.nz/fhir/ValueSet/medicationStatus", "code": "stopped" } ] } ], "deleted": true, "item": { "reference": "MedicationPrescription/1", "display": "use of Ventolin Inhaler was discontinued" } } ] } }, { "base": "urn:uuid:", "resource": { "resourceType": "MedicationPrescription", "id": "124a6916-5d84-4b8c-b250-10cefb8e6e86", "meta": { "lastUpdated": "2013-05-05T16:13:03Z" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "contained": [ { "resourceType": "Medication", "id": "med1", "name": "Theophylline 200mg", "code": { "coding": [ { "system": "http:/snomed.org", "code": "66493003" } ] } } ], "patient": { "reference": "http://fhir.healthintersections.com.au/open/Patient/d1", "display": "Peter Patient" }, "prescriber": { "reference": "Practitioner/example", "display": "Peter Practitioner" }, "reasonCodeableConcept": { "text": "Management of Asthma" }, "medication": { "reference": "Medication/example", "display": "Theophylline 200mg BD" }, "dosageInstruction": [ { "additionalInstructions": { "text": "Take with Food" }, "scheduledTiming": { "repeat": { "frequency": 2, "duration": 1, "units": "d" } }, "route": { "coding": [ { "system": "http://snomed.info/sct", "code": "394899003", "display": "oral administration of treatment" } ] }, "doseQuantity": { "value": 1, "units": "tablet", "system": "http://unitsofmeasure.org", "code": "tbl" } } ] } }, { "base": "urn:uuid:", "resource": { "resourceType": "List", "id": "68f86194-e6e1-4f65-b64a-5314256f8d7b", "meta": { "lastUpdated": "2013-05-05T16:13:03Z" }, "text": { "status": "additional", "div": "<div>!-- Snipped for Brevity --></div>" }, "code": { "coding": [ { "system": "http://loinc.org", "code": "48765-2", "display": "Allergies and adverse reactions Document" } ] }, "mode": "working", "entry": [ { "item": { "reference": "urn:uuid:47600e0f-b6b5-4308-84b5-5dec157f7637" } } ] } }, { "base": "urn:uuid:", "resource": { "resourceType": "AllergyIntolerance", "id": "47600e0f-b6b5-4308-84b5-5dec157f7637", "meta": { "lastUpdated": "2013-05-05T16:13:03Z" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "recordedDate": "2012-09-17", "subject": { "reference": "http://fhir.healthintersections.com.au/open/Patient/d1", "display": "Eve Everywoman" }, "substance": { "text": "Doxycycline" }, "status": "confirmed", "criticality": "high", "type": "immune", "event": [ { "manifestation": [ { "coding": [ { "system": "sys", "code": "xxx", "display": "Hives" } ], "text": "Hives" } ] } ] } } ] }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.