This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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:
XML
General Person Example (id = "example")
<Patient xmlns="http://hl7.org/fhir"> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <table> <tbody> <tr> <td>Name</td> <td>Peter James <b>Chalmers</b> ("Jim")</td> </tr> <tr> <td>Address</td> <td>534 Erewhon, Pleasantville, Vic, 3999</td> </tr> <tr> <td>Contacts</td> <td>Home: unknown. Work: (03) 5555 6473</td> </tr> <tr> <td>Id</td> <td>MRN: 12345 (Acme Healthcare)</td> </tr> </tbody> </table> </div> </text> <!-- MRN assigned by ACME healthcare on 6-May 2001 --> <identifier> <use value="usual"/> <label value="MRN"/> <system value="urn:oid:1.2.36.146.595.217.0.1"/> <value value="12345"/> <period> <start value="2001-05-06"/> </period> <assigner> <display value="Acme Healthcare"/> </assigner> </identifier> <!-- Peter James Chalmers, but called "Jim" --> <name> <use value="official"/> <family value="Chalmers"/> <given value="Peter"/> <given value="James"/> </name> <name> <use value="usual"/> <given value="Jim"/> </name> <telecom> <use value="home"/> <!-- home communication details aren't known --> </telecom> <telecom> <system value="phone"/> <value value="(03) 5555 6473"/> <use value="work"/> </telecom> <!-- use FHIR code system for male / female --> <gender> <coding> <system value="http://hl7.org/fhir/v3/AdministrativeGender"/> <code value="M"/> <display value="Male"/> </coding> </gender> <birthDate value="1974-12-25"/> <deceasedBoolean value="false"/> <address> <use value="home"/> <line value="534 Erewhon St"/> <city value="PleasantVille"/> <state value="Vic"/> <zip value="3999"/> </address> <contact> <relationship> <coding> <system value="http://hl7.org/fhir/patient-contact-relationship"/> <code value="partner"/> </coding> </relationship> <name> <family value="du"> <!-- the "du" part is a family name prefix (VV in iso 21090) --> <extension url="http://hl7.org/fhir/Profile/iso-21090#qualifier"> <valueCode value="VV"/> </extension> </family> <family value="Marché"/> <given value="Bénédicte"/> </name> <telecom> <system value="phone"/> <value value="+33 (237) 998327"/> </telecom> </contact> <managingOrganization> <reference value="Organization/1"/> </managingOrganization> <active value="true"/> </Patient>
JSON
General Person Example
{
"resourceType": "Patient",
"text": {
"status": "generated",
"div": "<div>\n <table>\n <tbody>\n <tr>\n <td>Name</td>\n <td>Peter James <b>Chalmers</b> ("Jim")</td>\n </tr>\n <tr>\n <td>Address</td>\n <td>534 Erewhon, Pleasantville, Vic, 3999</td>\n </tr>\n <tr>\n <td>Contacts</td>\n <td>Home: unknown. Work: (03) 5555 6473</td>\n </tr>\n <tr>\n <td>Id</td>\n <td>MRN: 12345 (Acme Healthcare)</td>\n </tr>\n </tbody>\n </table>\n </div>"
},
"identifier": [
{
"use": "usual",
"label": "MRN",
"system": "urn:oid:1.2.36.146.595.217.0.1",
"value": "12345",
"period": {
"start": "2001-05-06"
},
"assigner": {
"display": "Acme Healthcare"
}
}
],
"name": [
{
"use": "official",
"family": [
"Chalmers"
],
"given": [
"Peter",
"James"
]
},
{
"use": "usual",
"given": [
"Jim"
]
}
],
"telecom": [
{
"use": "home"
},
{
"system": "phone",
"value": "(03) 5555 6473",
"use": "work"
}
],
"gender": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/AdministrativeGender",
"code": "M",
"display": "Male"
}
]
},
"birthDate": "1974-12-25",
"deceasedBoolean": false,
"address": [
{
"use": "home",
"line": [
"534 Erewhon St"
],
"city": "PleasantVille",
"state": "Vic",
"zip": "3999"
}
],
"contact": [
{
"relationship": [
{
"coding": [
{
"system": "http://hl7.org/fhir/patient-contact-relationship",
"code": "partner"
}
]
}
],
"name": {
"family": [
"du",
"Marché"
],
"_family": [
{
"extension": [
{
"url": "http://hl7.org/fhir/Profile/iso-21090#qualifier",
"valueCode": "VV"
}
]
},
null
],
"given": [
"Bénédicte"
]
},
"telecom": [
{
"system": "phone",
"value": "+33 (237) 998327"
}
]
}
],
"managingOrganization": {
"reference": "Organization/1"
},
"active": true
}
XML
An example of an animal (id = "animal")
<Patient xmlns="http://hl7.org/fhir"> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <table> <tbody> <tr> <td>Id</td> <td>Kenzi (Dog: Golden Retriever)</td> </tr> <tr> <td>Owner</td> <td>Peter Chalmers, 534 Erewhon, Pleasantville, Vic, 3999</td> </tr> <tr> <td>Contacts</td> <td>Work: (03) 5555 6473</td> </tr> <tr> <td>Id</td> <td>Dog Tag: 1234123 (Maroondah City Council)</td> </tr> </tbody> </table> </div> </text> <!-- Dog tag, under Maroondah City council --> <identifier> <label value="Dog Tag"/> <system value="http://www.maroondah.vic.gov.au/AnimalRegFees.aspx"/> <value value="1234123"/> <period> <start value="2010-05-31"/> </period> <assigner> <display value="Maroondah City Council"/> </assigner> </identifier> <!-- Dog's name: Kenzi --> <name> <use value="usual"/> <given value="Kenzi"/> </name> <gender> <coding> <system value="http://hl7.org/fhir/v3/AdministrativeGender"/> <code value="F"/> </coding> </gender> <birthDate value="2010-03-23"/> <contact> <relationship> <coding> <system value="http://hl7.org/fhir/patient-contact-relationship"/> <code value="owner"/> </coding> </relationship> <name> <family value="Chalmers"/> <given value="Peter"/> <given value="James"/> </name> <telecom> <system value="phone"/> <value value="(03) 5555 6473"/> <use value="work"/> </telecom> </contact> <animal> <species> <coding> <system value="http://hl7.org/fhir/animal-species"/> <code value="canislf"/> <display value="Dog"/> </coding> </species> <breed> <coding> <system value="http://snomed.info/sct"/> <code value="58108001"/> <display value="Golden retriever"/> </coding> <coding> <system value="http://hl7.org/fhir/animal-breed"/> <code value="gret"/> <display value="Golden Retriever"/> </coding> </breed> <genderStatus> <coding> <system value="http://hl7.org/fhir/animal-genderstatus"/> <code value="neutered"/> </coding> </genderStatus> </animal> <managingOrganization> <display value="Pete's Vetinary Services"/> </managingOrganization> <active value="true"/> </Patient>
JSON
An example of an animal
{
"resourceType": "Patient",
"text": {
"status": "generated",
"div": "<div>\n <table>\n <tbody>\n <tr>\n <td>Id</td>\n <td>Kenzi (Dog: Golden Retriever)</td>\n </tr>\n <tr>\n <td>Owner</td>\n <td>Peter Chalmers, 534 Erewhon, Pleasantville, Vic, 3999</td>\n </tr>\n <tr>\n <td>Contacts</td>\n <td>Work: (03) 5555 6473</td>\n </tr>\n <tr>\n <td>Id</td>\n <td>Dog Tag: 1234123 (Maroondah City Council)</td>\n </tr>\n </tbody>\n </table>\n </div>"
},
"identifier": [
{
"label": "Dog Tag",
"system": "http://www.maroondah.vic.gov.au/AnimalRegFees.aspx",
"value": "1234123",
"period": {
"start": "2010-05-31"
},
"assigner": {
"display": "Maroondah City Council"
}
}
],
"name": [
{
"use": "usual",
"given": [
"Kenzi"
]
}
],
"gender": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/AdministrativeGender",
"code": "F"
}
]
},
"birthDate": "2010-03-23",
"contact": [
{
"relationship": [
{
"coding": [
{
"system": "http://hl7.org/fhir/patient-contact-relationship",
"code": "owner"
}
]
}
],
"name": {
"family": [
"Chalmers"
],
"given": [
"Peter",
"James"
]
},
"telecom": [
{
"system": "phone",
"value": "(03) 5555 6473",
"use": "work"
}
]
}
],
"animal": {
"species": {
"coding": [
{
"system": "http://hl7.org/fhir/animal-species",
"code": "canislf",
"display": "Dog"
}
]
},
"breed": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "58108001",
"display": "Golden retriever"
},
{
"system": "http://hl7.org/fhir/animal-breed",
"code": "gret",
"display": "Golden Retriever"
}
]
},
"genderStatus": {
"coding": [
{
"system": "http://hl7.org/fhir/animal-genderstatus",
"code": "neutered"
}
]
}
},
"managingOrganization": {
"display": "Pete's Vetinary Services"
},
"active": true
}