Examples
Examples Usage note:
Whilst every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.Example to illustrate the registered place of birth of the patient using the common extension
Table View
| Patient.id[0] | Patient-Extension-BirthPlace-Example |
| Patient.extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
| Patient.extension[0].valueAddress[0].line[0] | MATERNITY UNIT |
| Patient.extension[0].valueAddress[0].line[1] | LENVILLE UNIVERSITY HOSPITAL |
| Patient.extension[0].valueAddress[0].line[2] | BEWLEY STREET |
| Patient.extension[0].valueAddress[0].city[0] | LENVILLE |
| Patient.extension[0].valueAddress[0].postalCode[0] | LEN 7TF |
| Patient.extension[0].valueAddress[0].country[0] | ENGLAND |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="Patient-Extension-BirthPlace-Example" /> <!-- **************extension start************** --> <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthPlace"> <valueAddress> <line value="MATERNITY UNIT" /> <line value="LENVILLE UNIVERSITY HOSPITAL" /> <line value="BEWLEY STREET" /> <city value="LENVILLE" /> <postalCode value="LEN 7TF" /> <country value="ENGLAND" /> </valueAddress> </extension> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "Patient-Extension-BirthPlace-Example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace", "valueAddress": { "line": [ "MATERNITY UNIT", "LENVILLE UNIVERSITY HOSPITAL", "BEWLEY STREET" ], "city": "LENVILLE", "postalCode": "LEN 7TF", "country": "ENGLAND" } } ] }
Example to illustrate the Patients birth time using the common extension
Table View
| Patient.id[0] | Patient-Extension-BirthTime-Example |
| Patient.birthDate[0].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/patient-birthTime |
| Patient.birthDate[0].extension[0].valueDateTime[0] | 2002-03-11T15:39:00+00:00 |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="Patient-Extension-BirthTime-Example" /> <!-- **************extension start************** --> <birthDate> <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime"> <valueDateTime value="2002-03-11T15:39:00+00:00" /> </extension> </birthDate> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "Patient-Extension-BirthTime-Example", "_birthDate": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime", "valueDateTime": "2002-03-11T15:39:00+00:00" } ] } }
Example to illustrate a bundled allergy list
Table View
| Bundle.id[0] | UKCore-Bundle-BundledAllergyList-Example |
| Bundle.type[0] | collection |
| Bundle.entry[0].fullUrl[0] | urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb |
| Bundle.entry[0].resource[0].id[0] | UKCore-Allergy-List-Example |
| Bundle.entry[0].resource[0].meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-List |
| Bundle.entry[0].resource[0].status[0] | current |
| Bundle.entry[0].resource[0].mode[0] | snapshot |
| Bundle.entry[0].resource[0].code[0].coding[0].system[0] | http://snomed.info/sct |
| Bundle.entry[0].resource[0].code[0].coding[0].code[0] | 886921000000105 |
| Bundle.entry[0].resource[0].code[0].coding[0].display[0] | Allergies and adverse reactions |
| Bundle.entry[0].resource[0].subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| Bundle.entry[0].resource[0].date[0] | 2019-12-10T13:00:00+00:00 |
| Bundle.entry[0].resource[0].entry[0].item[0].reference[0] | urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4 |
| Bundle.entry[1].fullUrl[0] | urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4 |
| Bundle.entry[1].resource[0].id[0] | efae5859-28df-4e7d-be91-6df56d8215e4 |
| Bundle.entry[1].resource[0].meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance |
| Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
| Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].code[0] | active |
| Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].display[0] | Active |
| Bundle.entry[1].resource[0].verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
| Bundle.entry[1].resource[0].verificationStatus[0].coding[0].code[0] | confirmed |
| Bundle.entry[1].resource[0].verificationStatus[0].coding[0].display[0] | Confirmed |
| Bundle.entry[1].resource[0].type[0] | allergy |
| Bundle.entry[1].resource[0].category[0] | medication |
| Bundle.entry[1].resource[0].code[0].coding[0].system[0] | http://snomed.info/sct |
| Bundle.entry[1].resource[0].code[0].coding[0].code[0] | 372687004 |
| Bundle.entry[1].resource[0].code[0].coding[0].display[0] | Amoxicillin |
| Bundle.entry[1].resource[0].patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| Bundle.entry[1].resource[0].encounter[0].reference[0] | Encounter/UKCore-Encounter-InpatientEncounter-Example |
| Bundle.entry[1].resource[0].recordedDate[0] | 2019-12-10T13:00:00+00:00 |
| Bundle.entry[1].resource[0].recorder[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| Bundle.entry[1].resource[0].asserter[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].system[0] | http://snomed.info/sct |
| Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].code[0] | 247472004 |
| Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].display[0] | Urticarial rash |
| Bundle.entry[1].resource[0].reaction[0].severity[0] | mild |
XML View
<Bundle xmlns="http://hl7.org/fhir"> <id value="UKCore-Bundle-BundledAllergyList-Example" /> <type value="collection" /> <entry> <fullUrl value="urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb" /> <resource> <List> <id value="UKCore-Allergy-List-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" /> </meta> <status value="current" /> <mode value="snapshot" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="886921000000105" /> <display value="Allergies and adverse reactions" /> </coding> </code> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <date value="2019-12-10T13:00:00+00:00" /> <entry> <item> <reference value="urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" /> </item> </entry> </List> </resource> </entry> <entry> <fullUrl value="urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" /> <resource> <AllergyIntolerance> <id value="efae5859-28df-4e7d-be91-6df56d8215e4" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" /> </meta> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <type value="allergy" /> <category value="medication" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="372687004" /> <display value="Amoxicillin" /> </coding> </code> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <encounter> <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" /> </encounter> <recordedDate value="2019-12-10T13:00:00+00:00" /> <recorder> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </recorder> <asserter> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </asserter> <reaction> <manifestation> <coding> <system value="http://snomed.info/sct" /> <code value="247472004" /> <display value="Urticarial rash" /> </coding> </manifestation> <severity value="mild" /> </reaction> </AllergyIntolerance> </resource> </entry> </Bundle>
JSON View
{ "resourceType": "Bundle", "id": "UKCore-Bundle-BundledAllergyList-Example", "type": "collection", "entry": [ { "fullUrl": "urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb", "resource": { "resourceType": "List", "id": "UKCore-Allergy-List-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" ] }, "status": "current", "mode": "snapshot", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "886921000000105", "display": "Allergies and adverse reactions" } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "date": "2019-12-10T13:00:00+00:00", "entry": [ { "item": { "reference": "urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" } } ] } }, { "fullUrl": "urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4", "resource": { "resourceType": "AllergyIntolerance", "id": "efae5859-28df-4e7d-be91-6df56d8215e4", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" ] }, "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "type": "allergy", "category": [ "medication" ], "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "372687004", "display": "Amoxicillin" } ] }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "encounter": { "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example" }, "recordedDate": "2019-12-10T13:00:00+00:00", "recorder": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "asserter": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "reaction": [ { "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "247472004", "display": "Urticarial rash" } ] } ], "severity": "mild" } ] } } ] }
Example to illustrate whether the patient authorized the donation of body parts after death using the common extension
Table View
| Patient.id[0] | Patient-Extension-CadavericDonor-Example |
| Patient.extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor |
| Patient.extension[0].valueBoolean[0] | True |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="Patient-Extension-CadavericDonor-Example" /> <!-- **************extension start************** --> <extension url="http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"> <valueBoolean value="true" /> </extension> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "Patient-Extension-CadavericDonor-Example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor", "valueBoolean": true } ] }
Example to illustrate the professed religious affiliations of the patient using the common extension
Table View
| Patient.id[0] | Patient-Extension-Religion-Example |
| Patient.extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/patient-religion |
| Patient.extension[0].valueCodeableConcept[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation |
| Patient.extension[0].valueCodeableConcept[0].coding[0].code[0] | 1041 |
| Patient.extension[0].valueCodeableConcept[0].coding[0].display[0] | Roman Catholic Church |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="Patient-Extension-Religion-Example" /> <!-- **************extension start************** --> <extension url="http://hl7.org/fhir/StructureDefinition/patient-religion"> <valueCodeableConcept> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation" /> <code value="1041" /> <display value="Roman Catholic Church" /> </coding> </valueCodeableConcept> </extension> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "Patient-Extension-Religion-Example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/patient-religion", "valueCodeableConcept": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation", "code": "1041", "display": "Roman Catholic Church" } ] } } ] }
Example to illustrate the use of an address key used with the address data type
Table View
| Patient.id[0] | UKCore-Patient-Extension-AddressKey-Example |
| Patient.address[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey |
| Patient.address[0].extension[0].extension[0].url[0] | type |
| Patient.address[0].extension[0].extension[0].valueCoding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType |
| Patient.address[0].extension[0].extension[0].valueCoding[0].code[0] | PAF |
| Patient.address[0].extension[0].extension[0].valueCoding[0].display[0] | Postcode Address File |
| Patient.address[0].extension[0].extension[1].url[0] | value |
| Patient.address[0].extension[0].extension[1].valueString[0] | LS10ABC |
| Patient.address[0].line[0] | 4 Sandmoor Drive |
| Patient.address[0].city[0] | LEEDS |
| Patient.address[0].postalCode[0] | LS17 7DF |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-AddressKey-Example" /> <address> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"> <extension url="type"> <valueCoding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" /> <code value="PAF" /> <display value="Postcode Address File" /> </valueCoding> </extension> <extension url="value"> <valueString value="LS10ABC" /> </extension> </extension> <line value="4 Sandmoor Drive" /> <city value="LEEDS" /> <postalCode value="LS17 7DF" /> <!-- *************extension end ***************** --> </address> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-AddressKey-Example", "address": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey", "extension": [ { "url": "type", "valueCoding": { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType", "code": "PAF", "display": "Postcode Address File" } }, { "url": "value", "valueString": "LS10ABC" } ] } ], "line": [ "4 Sandmoor Drive" ], "city": "LEEDS", "postalCode": "LS17 7DF" } ] }
An example to illustrate an Allergy to Amoxicillin
Table View
| AllergyIntolerance.id[0] | UKCore-AllergyIntolerance-Amoxicillin-Example |
| AllergyIntolerance.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance |
| AllergyIntolerance.clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
| AllergyIntolerance.clinicalStatus[0].coding[0].code[0] | active |
| AllergyIntolerance.clinicalStatus[0].coding[0].display[0] | Active |
| AllergyIntolerance.verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
| AllergyIntolerance.verificationStatus[0].coding[0].code[0] | confirmed |
| AllergyIntolerance.verificationStatus[0].coding[0].display[0] | Confirmed |
| AllergyIntolerance.type[0] | allergy |
| AllergyIntolerance.category[0] | medication |
| AllergyIntolerance.code[0].coding[0].system[0] | http://snomed.info/sct |
| AllergyIntolerance.code[0].coding[0].code[0] | 372687004 |
| AllergyIntolerance.code[0].coding[0].display[0] | Amoxicillin |
| AllergyIntolerance.patient[0].reference[0] | Patient/UKCore-RichardSmith-Patient-Example |
| AllergyIntolerance.encounter[0].reference[0] | Encounter/UKCore-Encounter-InpatientEncounter-Example |
| AllergyIntolerance.recordedDate[0] | 2019-12-10T13:00:00+00:00 |
| AllergyIntolerance.recorder[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| AllergyIntolerance.asserter[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| AllergyIntolerance.reaction[0].manifestation[0].coding[0].system[0] | http://snomed.info/sct |
| AllergyIntolerance.reaction[0].manifestation[0].coding[0].code[0] | 247472004 |
| AllergyIntolerance.reaction[0].manifestation[0].coding[0].display[0] | Urticarial rash |
| AllergyIntolerance.reaction[0].severity[0] | mild |
XML View
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <id value="UKCore-AllergyIntolerance-Amoxicillin-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" /> </meta> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <type value="allergy" /> <category value="medication" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="372687004" /> <display value="Amoxicillin" /> </coding> </code> <patient> <reference value="Patient/UKCore-RichardSmith-Patient-Example" /> </patient> <encounter> <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" /> </encounter> <recordedDate value="2019-12-10T13:00:00+00:00" /> <recorder> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </recorder> <asserter> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </asserter> <reaction> <manifestation> <coding> <system value="http://snomed.info/sct" /> <code value="247472004" /> <display value="Urticarial rash" /> </coding> </manifestation> <severity value="mild" /> </reaction> </AllergyIntolerance>
JSON View
{ "resourceType": "AllergyIntolerance", "id": "UKCore-AllergyIntolerance-Amoxicillin-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" ] }, "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "type": "allergy", "category": [ "medication" ], "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "372687004", "display": "Amoxicillin" } ] }, "patient": { "reference": "Patient/UKCore-RichardSmith-Patient-Example" }, "encounter": { "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example" }, "recordedDate": "2019-12-10T13:00:00+00:00", "recorder": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "asserter": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "reaction": [ { "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "247472004", "display": "Urticarial rash" } ] } ], "severity": "mild" } ] }
An example to illustrate the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid
Table View
| AllergyIntolerance.id[0] | UKCore-AllergyIntolerance-Extension-AllergyIntolEnd-Example |
| AllergyIntolerance.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance |
| AllergyIntolerance.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd |
| AllergyIntolerance.extension[0].extension[0].url[0] | endDate |
| AllergyIntolerance.extension[0].extension[0].valueDateTime[0] | 2021-07-20T17:10:00+00:00 |
| AllergyIntolerance.extension[0].extension[1].url[0] | reasonEnded |
| AllergyIntolerance.extension[0].extension[1].valueString[0] | Administrative error corrected on patient record - confirmed that allergy not experienced with the patient. |
| AllergyIntolerance.clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
| AllergyIntolerance.clinicalStatus[0].coding[0].code[0] | inactive |
| AllergyIntolerance.clinicalStatus[0].coding[0].display[0] | Inactive |
| AllergyIntolerance.verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
| AllergyIntolerance.verificationStatus[0].coding[0].code[0] | confirmed |
| AllergyIntolerance.verificationStatus[0].coding[0].display[0] | Confirmed |
| AllergyIntolerance.type[0] | intolerance |
| AllergyIntolerance.category[0] | medication |
| AllergyIntolerance.code[0].coding[0].system[0] | http://snomed.info/sct |
| AllergyIntolerance.code[0].coding[0].code[0] | 372687004 |
| AllergyIntolerance.code[0].coding[0].display[0] | Amoxicillin |
| AllergyIntolerance.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| AllergyIntolerance.encounter[0].reference[0] | Encounter/UKCore-Encounter-InpatientEncounter-Example |
| AllergyIntolerance.recordedDate[0] | 2019-12-10T13:00:00+00:00 |
| AllergyIntolerance.recorder[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| AllergyIntolerance.asserter[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
XML View
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <id value="UKCore-AllergyIntolerance-Extension-AllergyIntolEnd-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" /> </meta> <!-- **************extension start************** --> <!-- This supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.. --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd"> <extension url="endDate"> <valueDateTime value="2021-07-20T17:10:00+00:00" /> </extension> <extension url="reasonEnded"> <valueString value="Administrative error corrected on patient record - confirmed that allergy not experienced with the patient." /> </extension> </extension> <!-- **************extension end************** --> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" /> <code value="inactive" /> <display value="Inactive" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <type value="intolerance" /> <category value="medication" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="372687004" /> <display value="Amoxicillin" /> </coding> </code> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <encounter> <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" /> </encounter> <recordedDate value="2019-12-10T13:00:00+00:00" /> <recorder> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </recorder> <asserter> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </asserter> </AllergyIntolerance>
JSON View
{ "resourceType": "AllergyIntolerance", "id": "UKCore-AllergyIntolerance-Extension-AllergyIntolEnd-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd", "extension": [ { "url": "endDate", "valueDateTime": "2021-07-20T17:10:00+00:00" }, { "url": "reasonEnded", "valueString": "Administrative error corrected on patient record - confirmed that allergy not experienced with the patient." } ] } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "inactive", "display": "Inactive" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "type": "intolerance", "category": [ "medication" ], "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "372687004", "display": "Amoxicillin" } ] }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "encounter": { "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example" }, "recordedDate": "2019-12-10T13:00:00+00:00", "recorder": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "asserter": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" } }
An example to illustrate an Allergy that was entered in error
Table View
| AllergyIntolerance.id[0] | UKCore-AllergyIntolerance-EnteredInError-Example |
| AllergyIntolerance.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance |
| AllergyIntolerance.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd |
| AllergyIntolerance.extension[0].extension[0].url[0] | endDate |
| AllergyIntolerance.extension[0].extension[0].valueDateTime[0] | 2020-03-11T13:00:00+00:00 |
| AllergyIntolerance.extension[0].extension[1].url[0] | reasonEnded |
| AllergyIntolerance.extension[0].extension[1].valueString[0] | Administrative error corrected on patient record - confirmed that allergy not experienced with the patient. |
| AllergyIntolerance.verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
| AllergyIntolerance.verificationStatus[0].coding[0].code[0] | entered-in-error |
| AllergyIntolerance.verificationStatus[0].coding[0].display[0] | Entered in Error |
| AllergyIntolerance.type[0] | allergy |
| AllergyIntolerance.category[0] | medication |
| AllergyIntolerance.code[0].coding[0].system[0] | http://snomed.info/sct |
| AllergyIntolerance.code[0].coding[0].code[0] | 372687004 |
| AllergyIntolerance.code[0].coding[0].display[0] | Amoxicillin |
| AllergyIntolerance.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| AllergyIntolerance.encounter[0].reference[0] | Encounter/UKCore-Encounter-InpatientEncounter-Example |
| AllergyIntolerance.recordedDate[0] | 2019-12-10T13:00:00+00:00 |
| AllergyIntolerance.recorder[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| AllergyIntolerance.asserter[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
XML View
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <id value="UKCore-AllergyIntolerance-EnteredInError-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" /> </meta> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd"> <extension url="endDate"> <valueDateTime value="2020-03-11T13:00:00+00:00" /> </extension> <extension url="reasonEnded"> <valueString value="Administrative error corrected on patient record - confirmed that allergy not experienced with the patient." /> </extension> </extension> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="entered-in-error" /> <display value="Entered in Error" /> </coding> </verificationStatus> <type value="allergy" /> <category value="medication" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="372687004" /> <display value="Amoxicillin" /> </coding> </code> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <encounter> <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" /> </encounter> <recordedDate value="2019-12-10T13:00:00+00:00" /> <recorder> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </recorder> <asserter> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </asserter> </AllergyIntolerance>
JSON View
{ "resourceType": "AllergyIntolerance", "id": "UKCore-AllergyIntolerance-EnteredInError-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd", "extension": [ { "url": "endDate", "valueDateTime": "2020-03-11T13:00:00+00:00" }, { "url": "reasonEnded", "valueString": "Administrative error corrected on patient record - confirmed that allergy not experienced with the patient." } ] } ], "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "entered-in-error", "display": "Entered in Error" } ] }, "type": "allergy", "category": [ "medication" ], "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "372687004", "display": "Amoxicillin" } ] }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "encounter": { "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example" }, "recordedDate": "2019-12-10T13:00:00+00:00", "recorder": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "asserter": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" } }
An example to illustrate a reference to results of investigations that confirmed the certainty of the diagnosis for an allergy or intolerance
Table View
| AllergyIntolerance.id[0] | UKCore-AllergyIntolerance-Extension-Evidence-Example |
| AllergyIntolerance.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance |
| AllergyIntolerance.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence |
| AllergyIntolerance.extension[0].valueReference[0].reference[0] | DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example |
| AllergyIntolerance.extension[0].valueReference[0].type[0] | DiagnosticReport |
| AllergyIntolerance.clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
| AllergyIntolerance.clinicalStatus[0].coding[0].code[0] | active |
| AllergyIntolerance.clinicalStatus[0].coding[0].display[0] | Active |
| AllergyIntolerance.verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
| AllergyIntolerance.verificationStatus[0].coding[0].code[0] | confirmed |
| AllergyIntolerance.verificationStatus[0].coding[0].display[0] | Confirmed |
| AllergyIntolerance.type[0] | allergy |
| AllergyIntolerance.category[0] | medication |
| AllergyIntolerance.code[0].coding[0].system[0] | http://snomed.info/sct |
| AllergyIntolerance.code[0].coding[0].code[0] | 372687004 |
| AllergyIntolerance.code[0].coding[0].display[0] | Amoxicillin |
| AllergyIntolerance.patient[0].reference[0] | Patient/UKCore-RichardSmith-Patient-Example |
| AllergyIntolerance.encounter[0].reference[0] | Encounter/UKCore-Encounter-InpatientEncounter-Example |
| AllergyIntolerance.recordedDate[0] | 2019-12-10T13:00:00+00:00 |
| AllergyIntolerance.recorder[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| AllergyIntolerance.asserter[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| AllergyIntolerance.reaction[0].manifestation[0].coding[0].system[0] | http://snomed.info/sct |
| AllergyIntolerance.reaction[0].manifestation[0].coding[0].code[0] | 247472004 |
| AllergyIntolerance.reaction[0].manifestation[0].coding[0].display[0] | Urticarial rash |
| AllergyIntolerance.reaction[0].severity[0] | mild |
XML View
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <id value="UKCore-AllergyIntolerance-Extension-Evidence-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" /> </meta> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence"> <valueReference> <reference value="DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example" /> <type value="DiagnosticReport" /> </valueReference> </extension> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <type value="allergy" /> <category value="medication" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="372687004" /> <display value="Amoxicillin" /> </coding> </code> <patient> <reference value="Patient/UKCore-RichardSmith-Patient-Example" /> </patient> <encounter> <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" /> </encounter> <recordedDate value="2019-12-10T13:00:00+00:00" /> <recorder> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </recorder> <asserter> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </asserter> <reaction> <manifestation> <coding> <system value="http://snomed.info/sct" /> <code value="247472004" /> <display value="Urticarial rash" /> </coding> </manifestation> <severity value="mild" /> </reaction> </AllergyIntolerance>
JSON View
{ "resourceType": "AllergyIntolerance", "id": "UKCore-AllergyIntolerance-Extension-Evidence-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence", "valueReference": { "reference": "DiagnosticReport/UKCore-DiagnosticReport-DiagnosticStudiesReport-Example", "type": "DiagnosticReport" } } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "type": "allergy", "category": [ "medication" ], "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "372687004", "display": "Amoxicillin" } ] }, "patient": { "reference": "Patient/UKCore-RichardSmith-Patient-Example" }, "encounter": { "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example" }, "recordedDate": "2019-12-10T13:00:00+00:00", "recorder": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "asserter": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "reaction": [ { "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "247472004", "display": "Urticarial rash" } ] } ], "severity": "mild" } ] }
An example to illustrate a bundled Allergy List
Table View
| Bundle.id[0] | UKCore-Bundle-BundledAllergyList-Example |
| Bundle.type[0] | collection |
| Bundle.entry[0].fullUrl[0] | urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb |
| Bundle.entry[0].resource[0].id[0] | UKCore-Allergy-List-Example |
| Bundle.entry[0].resource[0].meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-List |
| Bundle.entry[0].resource[0].status[0] | current |
| Bundle.entry[0].resource[0].mode[0] | snapshot |
| Bundle.entry[0].resource[0].code[0].coding[0].system[0] | http://snomed.info/sct |
| Bundle.entry[0].resource[0].code[0].coding[0].code[0] | 886921000000105 |
| Bundle.entry[0].resource[0].code[0].coding[0].display[0] | Allergies and adverse reactions |
| Bundle.entry[0].resource[0].subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| Bundle.entry[0].resource[0].date[0] | 2019-12-10T13:00:00+00:00 |
| Bundle.entry[0].resource[0].entry[0].item[0].reference[0] | urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4 |
| Bundle.entry[1].fullUrl[0] | urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4 |
| Bundle.entry[1].resource[0].id[0] | efae5859-28df-4e7d-be91-6df56d8215e4 |
| Bundle.entry[1].resource[0].meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance |
| Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical |
| Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].code[0] | active |
| Bundle.entry[1].resource[0].clinicalStatus[0].coding[0].display[0] | Active |
| Bundle.entry[1].resource[0].verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
| Bundle.entry[1].resource[0].verificationStatus[0].coding[0].code[0] | confirmed |
| Bundle.entry[1].resource[0].verificationStatus[0].coding[0].display[0] | Confirmed |
| Bundle.entry[1].resource[0].type[0] | allergy |
| Bundle.entry[1].resource[0].category[0] | medication |
| Bundle.entry[1].resource[0].code[0].coding[0].system[0] | http://snomed.info/sct |
| Bundle.entry[1].resource[0].code[0].coding[0].code[0] | 372687004 |
| Bundle.entry[1].resource[0].code[0].coding[0].display[0] | Amoxicillin |
| Bundle.entry[1].resource[0].patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| Bundle.entry[1].resource[0].encounter[0].reference[0] | Encounter/UKCore-Encounter-InpatientEncounter-Example |
| Bundle.entry[1].resource[0].recordedDate[0] | 2019-12-10T13:00:00+00:00 |
| Bundle.entry[1].resource[0].recorder[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| Bundle.entry[1].resource[0].asserter[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].system[0] | http://snomed.info/sct |
| Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].code[0] | 247472004 |
| Bundle.entry[1].resource[0].reaction[0].manifestation[0].coding[0].display[0] | Urticarial rash |
| Bundle.entry[1].resource[0].reaction[0].severity[0] | mild |
XML View
<Bundle xmlns="http://hl7.org/fhir"> <id value="UKCore-Bundle-BundledAllergyList-Example" /> <type value="collection" /> <entry> <fullUrl value="urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb" /> <resource> <List> <id value="UKCore-Allergy-List-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" /> </meta> <status value="current" /> <mode value="snapshot" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="886921000000105" /> <display value="Allergies and adverse reactions" /> </coding> </code> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <date value="2019-12-10T13:00:00+00:00" /> <entry> <item> <reference value="urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" /> </item> </entry> </List> </resource> </entry> <entry> <fullUrl value="urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" /> <resource> <AllergyIntolerance> <id value="efae5859-28df-4e7d-be91-6df56d8215e4" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" /> </meta> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <type value="allergy" /> <category value="medication" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="372687004" /> <display value="Amoxicillin" /> </coding> </code> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <encounter> <reference value="Encounter/UKCore-Encounter-InpatientEncounter-Example" /> </encounter> <recordedDate value="2019-12-10T13:00:00+00:00" /> <recorder> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </recorder> <asserter> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </asserter> <reaction> <manifestation> <coding> <system value="http://snomed.info/sct" /> <code value="247472004" /> <display value="Urticarial rash" /> </coding> </manifestation> <severity value="mild" /> </reaction> </AllergyIntolerance> </resource> </entry> </Bundle>
JSON View
{ "resourceType": "Bundle", "id": "UKCore-Bundle-BundledAllergyList-Example", "type": "collection", "entry": [ { "fullUrl": "urn:uuid:d043d2b6-5782-4536-88b6-e537973a09fb", "resource": { "resourceType": "List", "id": "UKCore-Allergy-List-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" ] }, "status": "current", "mode": "snapshot", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "886921000000105", "display": "Allergies and adverse reactions" } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "date": "2019-12-10T13:00:00+00:00", "entry": [ { "item": { "reference": "urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4" } } ] } }, { "fullUrl": "urn:uuid:efae5859-28df-4e7d-be91-6df56d8215e4", "resource": { "resourceType": "AllergyIntolerance", "id": "efae5859-28df-4e7d-be91-6df56d8215e4", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance" ] }, "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ] }, "type": "allergy", "category": [ "medication" ], "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "372687004", "display": "Amoxicillin" } ] }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "encounter": { "reference": "Encounter/UKCore-Encounter-InpatientEncounter-Example" }, "recordedDate": "2019-12-10T13:00:00+00:00", "recorder": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "asserter": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "reaction": [ { "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "247472004", "display": "Urticarial rash" } ] } ], "severity": "mild" } ] } } ] }
An example to illustrate a patient's contact perferences
Table View
| Patient.id[0] | UKCore-Patient-Extension-ContactPreference-Example |
| Patient.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
| Patient.extension[0].extension[0].url[0] | PreferredContactMethod |
| Patient.extension[0].extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod |
| Patient.extension[0].extension[0].valueCodeableConcept[0].coding[0].code[0] | 3 |
| Patient.extension[0].extension[0].valueCodeableConcept[0].coding[0].display[0] | Telephone |
| Patient.extension[0].extension[1].url[0] | PreferredContactTimes |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].frequency[0] | 1 |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].period[0] | 1 |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].periodUnit[0] | d |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[0] | mon |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[1] | wed |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[2] | fri |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].when[0] | MORN |
| Patient.extension[0].extension[2].url[0] | PreferredWrittenCommunicationFormat |
| Patient.extension[0].extension[2].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat |
| Patient.extension[0].extension[2].valueCodeableConcept[0].coding[0].code[0] | 11 |
| Patient.extension[0].extension[2].valueCodeableConcept[0].coding[0].display[0] | Large print |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-ContactPreference-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"> <extension url="PreferredContactMethod"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod" /> <code value="3" /> <display value="Telephone" /> </coding> </valueCodeableConcept> </extension> <extension url="PreferredContactTimes"> <valueTiming> <repeat> <frequency value="1" /> <period value="1" /> <periodUnit value="d" /> <dayOfWeek value="mon" /> <dayOfWeek value="wed" /> <dayOfWeek value="fri" /> <when value="MORN" /> </repeat> </valueTiming> </extension> <extension url="PreferredWrittenCommunicationFormat"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat" /> <code value="11" /> <display value="Large print" /> </coding> </valueCodeableConcept> </extension> </extension> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-ContactPreference-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference", "extension": [ { "url": "PreferredContactMethod", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod", "code": "3", "display": "Telephone" } ] } }, { "url": "PreferredContactTimes", "valueTiming": { "repeat": { "frequency": 1, "period": 1, "periodUnit": "d", "dayOfWeek": [ "mon", "wed", "fri" ], "when": [ "MORN" ] } } }, { "url": "PreferredWrittenCommunicationFormat", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat", "code": "11", "display": "Large print" } ] } } ] } ] }
An example to illustrate the extension which adds a SNOMED CT description Id to CodeableConcept.
Table View
| Condition.id[0] | UKCore-Condition-Extension-CodingSCTDescId-Example |
| Condition.code[0].coding[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId |
| Condition.code[0].coding[0].extension[0].extension[0].url[0] | descriptionId |
| Condition.code[0].coding[0].extension[0].extension[0].valueIdentifier[0].value[0] | 301480018 |
| Condition.code[0].coding[0].extension[0].extension[1].url[0] | descriptionDisplay |
| Condition.code[0].coding[0].extension[0].extension[1].valueString[0] | Bronchial asthma |
| Condition.code[0].coding[0].system[0] | http://snomed.info/sct |
| Condition.code[0].coding[0].code[0] | 195967001 |
| Condition.code[0].coding[0].display[0] | Asthma |
| Condition.code[0].coding[0].userSelected[0] | True |
| Condition.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
XML View
<Condition xmlns="http://hl7.org/fhir"> <id value="UKCore-Condition-Extension-CodingSCTDescId-Example" /> <code> <coding> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId"> <extension url="descriptionId"> <valueIdentifier> <value value="301480018" /> </valueIdentifier> </extension> <extension url="descriptionDisplay"> <valueString value="Bronchial asthma" /> </extension> </extension> <system value="http://snomed.info/sct" /> <code value="195967001" /> <display value="Asthma" /> <userSelected value="true" /> </coding> </code> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> </Condition>
JSON View
{ "resourceType": "Condition", "id": "UKCore-Condition-Extension-CodingSCTDescId-Example", "code": { "coding": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CodingSCTDescId", "extension": [ { "url": "descriptionId", "valueIdentifier": { "value": "301480018" } }, { "url": "descriptionDisplay", "valueString": "Bronchial asthma" } ] } ], "system": "http://snomed.info/sct", "code": "195967001", "display": "Asthma", "userSelected": true } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } }
An example to illustrate patient bleeding from ear
Table View
| Condition.id[0] | UKCore-Condition-BleedingFromEar-Example |
| Condition.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition |
| Condition.clinicalStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/condition-clinical |
| Condition.clinicalStatus[0].coding[0].code[0] | active |
| Condition.clinicalStatus[0].coding[0].display[0] | Active |
| Condition.verificationStatus[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/condition-ver-status |
| Condition.verificationStatus[0].coding[0].code[0] | confirmed |
| Condition.verificationStatus[0].coding[0].display[0] | Confirmed |
| Condition.category[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/condition-category |
| Condition.category[0].coding[0].code[0] | encounter-diagnosis |
| Condition.category[0].coding[0].display[0] | Encounter Diagnosis |
| Condition.code[0].coding[0].system[0] | http://snomed.info/sct |
| Condition.code[0].coding[0].code[0] | 26322001 |
| Condition.code[0].coding[0].display[0] | Bleeding from ear |
| Condition.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
XML View
<Condition xmlns="http://hl7.org/fhir"> <id value="UKCore-Condition-BleedingFromEar-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" /> </meta> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <verificationStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-ver-status" /> <code value="confirmed" /> <display value="Confirmed" /> </coding> </verificationStatus> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-category" /> <code value="encounter-diagnosis" /> <display value="Encounter Diagnosis" /> </coding> </category> <code> <coding> <system value="http://snomed.info/sct" /> <code value="26322001" /> <display value="Bleeding from ear" /> </coding> </code> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> </Condition>
JSON View
{ "resourceType": "Condition", "id": "UKCore-Condition-BleedingFromEar-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" ] }, "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "active", "display": "Active" } ] }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed", "display": "Confirmed" } ] }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ] } ], "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "26322001", "display": "Bleeding from ear" } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } }
An example to illustrate the extension which is used to indicate the a person should have a copy of the correspondence
Table View
| Patient.id[0] | UKCore-Patient-Extension-CopyCorrespondenceIndicator-Example |
| Patient.contact[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
| Patient.contact[0].extension[0].valueBoolean[0] | True |
| Patient.contact[0].name[0].use[0] | official |
| Patient.contact[0].name[0].family[0] | CARTER |
| Patient.contact[0].name[0].given[0] | Emily |
| Patient.contact[0].telecom[0].system[0] | phone |
| Patient.contact[0].telecom[0].value[0] | 01131231288 |
| Patient.contact[0].gender[0] | female |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-CopyCorrespondenceIndicator-Example" /> <contact> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator"> <valueBoolean value="true" /> </extension> <!-- **************extension end************** --> <name> <use value="official" /> <family value="CARTER" /> <given value="Emily" /> </name> <telecom> <system value="phone" /> <value value="01131231288" /> </telecom> <gender value="female" /> </contact> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-CopyCorrespondenceIndicator-Example", "contact": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator", "valueBoolean": true } ], "name": { "use": "official", "family": "CARTER", "given": [ "Emily" ] }, "telecom": [ { "system": "phone", "value": "01131231288" } ], "gender": "female" } ] }
An example to illustrate an Inpatient encounter
Table View
| Encounter.id[0] | UKCore-Encounter-InpatientEncounter-Example |
| Encounter.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter |
| Encounter.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod |
| Encounter.extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland |
| Encounter.extension[0].valueCodeableConcept[0].coding[0].code[0] | 13 |
| Encounter.extension[0].valueCodeableConcept[0].coding[0].display[0] | Elective Admission: Planned |
| Encounter.extension[1].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod |
| Encounter.extension[1].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeMethodEngland |
| Encounter.extension[1].valueCodeableConcept[0].coding[0].code[0] | 1 |
| Encounter.extension[1].valueCodeableConcept[0].coding[0].display[0] | Patient discharged on clinical advice or with clinical consent |
| Encounter.identifier[0].system[0] | https://tools.ietf.org/html/rfc4122 |
| Encounter.identifier[0].value[0] | 6f40cebe-7b55-461d-9d7f-eadb4c065762 |
| Encounter.status[0] | finished |
| Encounter.class[0].system[0] | http://terminology.hl7.org/CodeSystem/v3-ActCode |
| Encounter.class[0].code[0] | IMP |
| Encounter.class[0].display[0] | inpatient encounter |
| Encounter.type[0].coding[0].system[0] | http://snomed.info/sct |
| Encounter.type[0].coding[0].code[0] | 185212007 |
| Encounter.type[0].coding[0].display[0] | Seen in hospital ward |
| Encounter.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| Encounter.participant[0].type[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/v3-ParticipationType |
| Encounter.participant[0].type[0].coding[0].code[0] | ATND |
| Encounter.participant[0].type[0].coding[0].display[0] | attender |
| Encounter.participant[0].individual[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| Encounter.period[0].start[0] | 2019-12-10T13:00:00+00:00 |
| Encounter.period[0].end[0] | 2019-12-11T13:00:00+00:00 |
| Encounter.reasonCode[0].coding[0].system[0] | http://snomed.info/sct |
| Encounter.reasonCode[0].coding[0].code[0] | 7922000 |
| Encounter.reasonCode[0].coding[0].display[0] | General treatment |
| Encounter.hospitalization[0].dischargeDisposition[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/NHSDataModelAndDictionary-DischargeDestination |
| Encounter.hospitalization[0].dischargeDisposition[0].coding[0].code[0] | 19 |
| Encounter.hospitalization[0].dischargeDisposition[0].coding[0].display[0] | Usual place of residence unless listed below, for example, a private dwelling whether owner occupied or owned by Local Authority, housing association or other landlord. This includes wardened accommodation but not residential accommodation where health care is provided. It also includes Patients with no fixed abode. |
| Encounter.location[0].location[0].reference[0] | Location/UKCore-Location-CardiologySJUH-Example |
| Encounter.serviceProvider[0].reference[0] | Organization/UKCore-Organization-LeedsTeachingHospital-Example |
XML View
<Encounter xmlns="http://hl7.org/fhir"> <id value="UKCore-Encounter-InpatientEncounter-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter" /> </meta> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland" /> <code value="13" /> <display value="Elective Admission: Planned" /> </coding> </valueCodeableConcept> </extension> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeMethodEngland" /> <code value="1" /> <display value="Patient discharged on clinical advice or with clinical consent" /> </coding> </valueCodeableConcept> </extension> <identifier> <system value="https://tools.ietf.org/html/rfc4122" /> <value value="6f40cebe-7b55-461d-9d7f-eadb4c065762" /> </identifier> <status value="finished" /> <class> <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" /> <code value="IMP" /> <display value="inpatient encounter" /> </class> <type> <coding> <system value="http://snomed.info/sct" /> <code value="185212007" /> <display value="Seen in hospital ward" /> </coding> </type> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <participant> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType" /> <code value="ATND" /> <display value="attender" /> </coding> </type> <individual> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </individual> </participant> <period> <start value="2019-12-10T13:00:00+00:00" /> <end value="2019-12-11T13:00:00+00:00" /> </period> <reasonCode> <coding> <system value="http://snomed.info/sct" /> <code value="7922000" /> <display value="General treatment" /> </coding> </reasonCode> <hospitalization> <dischargeDisposition> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/NHSDataModelAndDictionary-DischargeDestination" /> <code value="19" /> <display value="Usual place of residence unless listed below, for example, a private dwelling whether owner occupied or owned by Local Authority, housing association or other landlord. This includes wardened accommodation but not residential accommodation where health care is provided. It also includes Patients with no fixed abode." /> </coding> </dischargeDisposition> </hospitalization> <location> <location> <reference value="Location/UKCore-Location-CardiologySJUH-Example" /> </location> </location> <serviceProvider> <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" /> </serviceProvider> </Encounter>
JSON View
{ "resourceType": "Encounter", "id": "UKCore-Encounter-InpatientEncounter-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland", "code": "13", "display": "Elective Admission: Planned" } ] } }, { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeMethodEngland", "code": "1", "display": "Patient discharged on clinical advice or with clinical consent" } ] } } ], "identifier": [ { "system": "https://tools.ietf.org/html/rfc4122", "value": "6f40cebe-7b55-461d-9d7f-eadb4c065762" } ], "status": "finished", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "IMP", "display": "inpatient encounter" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "185212007", "display": "Seen in hospital ward" } ] } ], "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "ATND", "display": "attender" } ] } ], "individual": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" } } ], "period": { "start": "2019-12-10T13:00:00+00:00", "end": "2019-12-11T13:00:00+00:00" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "7922000", "display": "General treatment" } ] } ], "hospitalization": { "dischargeDisposition": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/NHSDataModelAndDictionary-DischargeDestination", "code": "19", "display": "Usual place of residence unless listed below, for example, a private dwelling whether owner occupied or owned by Local Authority, housing association or other landlord. This includes wardened accommodation but not residential accommodation where health care is provided. It also includes Patients with no fixed abode." } ] } }, "location": [ { "location": { "reference": "Location/UKCore-Location-CardiologySJUH-Example" } } ], "serviceProvider": { "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example" } }
An example to illustrate an episode of care for smoking cessation therapy
Table View
| EpisodeOfCare.id[0] | UKCore-EpisodeOfCare-SmokingCessationTherapy-Example |
| EpisodeOfCare.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-EpisodeOfCare |
| EpisodeOfCare.status[0] | finished |
| EpisodeOfCare.type[0].coding[0].system[0] | http://snomed.info/sct |
| EpisodeOfCare.type[0].coding[0].code[0] | 710081004 |
| EpisodeOfCare.type[0].coding[0].display[0] | Smoking cessation therapy |
| EpisodeOfCare.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| EpisodeOfCare.managingOrganization[0].reference[0] | Organization/UKCore-Organization-LeedsTeachingHospital-Example |
XML View
<EpisodeOfCare xmlns="http://hl7.org/fhir"> <id value="UKCore-EpisodeOfCare-SmokingCessationTherapy-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-EpisodeOfCare" /> </meta> <status value="finished" /> <type> <coding> <system value="http://snomed.info/sct" /> <code value="710081004" /> <display value="Smoking cessation therapy" /> </coding> </type> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <managingOrganization> <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" /> </managingOrganization> </EpisodeOfCare>
JSON View
{ "resourceType": "EpisodeOfCare", "id": "UKCore-EpisodeOfCare-SmokingCessationTherapy-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-EpisodeOfCare" ] }, "status": "finished", "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "710081004", "display": "Smoking cessation therapy" } ] } ], "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "managingOrganization": { "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example" } }
An example to illustrate the extension which is used to indicate the a person requires an interpreter
Table View
| Patient |
| id : Patient-Extension-InterpreterRequired-Example |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
| value : True |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="Patient-Extension-InterpreterRequired-Example" /> <!-- **************extension start************** --> <extension url="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"> <valueBoolean value="true" /> </extension> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "Patient-Extension-InterpreterRequired-Example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired", "valueBoolean": true } ] }
An example to illustrate an empty list
Table View
| List.id[0] | UKCore-List-EmptyList-Example |
| List.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-List |
| List.status[0] | current |
| List.mode[0] | working |
| List.code[0].coding[0].system[0] | http://snomed.info/sct |
| List.code[0].coding[0].code[0] | 826501000000100 |
| List.code[0].coding[0].display[0] | Miscellaneous record |
| List.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| List.date[0] | 2019-12-10T13:00:00+00:00 |
| List.emptyReason[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-ListEmptyReasonCode |
| List.emptyReason[0].coding[0].code[0] | no-content-recorded |
| List.emptyReason[0].coding[0].display[0] | No Content Recorded |
XML View
<List xmlns="http://hl7.org/fhir"> <id value="UKCore-List-EmptyList-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" /> </meta> <status value="current" /> <mode value="working" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="826501000000100" /> <display value="Miscellaneous record" /> </coding> </code> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <date value="2019-12-10T13:00:00+00:00" /> <emptyReason> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-ListEmptyReasonCode" /> <code value="no-content-recorded" /> <display value="No Content Recorded" /> </coding> </emptyReason> </List>
JSON View
{ "resourceType": "List", "id": "UKCore-List-EmptyList-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" ] }, "status": "current", "mode": "working", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "826501000000100", "display": "Miscellaneous record" } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "date": "2019-12-10T13:00:00+00:00", "emptyReason": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-ListEmptyReasonCode", "code": "no-content-recorded", "display": "No Content Recorded" } ] } }
An example to illustrate a general practice nurse clinic location
Table View
| Location.id[0] | UKCore-Location-GeneralPracticeNurseClinic-Example |
| Location.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location |
| Location.identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-site-code |
| Location.identifier[0].value[0] | GP8D7 |
| Location.name[0] | WhiteRoseNurseClinic |
| Location.type[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/v3-RoleCode |
| Location.type[0].coding[0].code[0] | GIM |
| Location.type[0].coding[0].display[0] | General internal medicine clinic |
| Location.telecom[0].system[0] | phone |
| Location.telecom[0].value[0] | 0113 243 3166 |
| Location.managingOrganization[0].reference[0] | Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example |
XML View
<Location xmlns="http://hl7.org/fhir"> <id value="UKCore-Location-GeneralPracticeNurseClinic-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" /> </meta> <identifier> <system value="https://fhir.nhs.uk/Id/ods-site-code" /> <value value="GP8D7" /> </identifier> <name value="WhiteRoseNurseClinic" /> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" /> <code value="GIM" /> <display value="General internal medicine clinic" /> </coding> </type> <telecom> <system value="phone" /> <value value="0113 243 3166" /> </telecom> <managingOrganization> <reference value="Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example" /> </managingOrganization> </Location>
JSON View
{ "resourceType": "Location", "id": "UKCore-Location-GeneralPracticeNurseClinic-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" ] }, "identifier": [ { "system": "https://fhir.nhs.uk/Id/ods-site-code", "value": "GP8D7" } ], "name": "WhiteRoseNurseClinic", "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "GIM", "display": "General internal medicine clinic" } ] } ], "telecom": [ { "system": "phone", "value": "0113 243 3166" } ], "managingOrganization": { "reference": "Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example" } }
An example to illustrate a Cardiology SJUH location
Table View
| Location.id[0] | UKCore-Location-CardiologySJUH-Example |
| Location.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location |
| Location.identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-site-code |
| Location.identifier[0].value[0] | RR8D7 |
| Location.name[0] | CARDIOLOGY SJUH |
| Location.type[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/v3-RoleCode |
| Location.type[0].coding[0].code[0] | CARD |
| Location.type[0].coding[0].display[0] | Ambulatory Health Care Facilities; Clinic/Center; Rehabilitation: Cardiac Facilities |
| Location.telecom[0].system[0] | phone |
| Location.telecom[0].value[0] | 0113 243 3149 |
| Location.address[0].line[0] | CARDIOLOGY SJUH |
| Location.address[0].line[1] | ST. JAMES'S UNIVERSITY HOSPITAL |
| Location.address[0].line[2] | BECKETT STREET |
| Location.address[0].city[0] | LEEDS |
| Location.address[0].postalCode[0] | LS9 7TF |
| Location.address[0].country[0] | ENGLAND |
| Location.managingOrganization[0].reference[0] | Organization/UKCore-Organization-LeedsTeachingHospital-Example |
XML View
<Location xmlns="http://hl7.org/fhir"> <id value="UKCore-Location-CardiologySJUH-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" /> </meta> <identifier> <system value="https://fhir.nhs.uk/Id/ods-site-code" /> <value value="RR8D7" /> </identifier> <name value="CARDIOLOGY SJUH" /> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" /> <code value="CARD" /> <display value="Ambulatory Health Care Facilities; Clinic/Center; Rehabilitation: Cardiac Facilities" /> </coding> </type> <telecom> <system value="phone" /> <value value="0113 243 3149" /> </telecom> <address> <line value="CARDIOLOGY SJUH" /> <line value="ST. JAMES'S UNIVERSITY HOSPITAL" /> <line value="BECKETT STREET" /> <city value="LEEDS" /> <postalCode value="LS9 7TF" /> <country value="ENGLAND" /> </address> <managingOrganization> <reference value="Organization/UKCore-Organization-LeedsTeachingHospital-Example" /> </managingOrganization> </Location>
JSON View
{ "resourceType": "Location", "id": "UKCore-Location-CardiologySJUH-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" ] }, "identifier": [ { "system": "https://fhir.nhs.uk/Id/ods-site-code", "value": "RR8D7" } ], "name": "CARDIOLOGY SJUH", "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "CARD", "display": "Ambulatory Health Care Facilities; Clinic/Center; Rehabilitation: Cardiac Facilities" } ] } ], "telecom": [ { "system": "phone", "value": "0113 243 3149" } ], "address": { "line": [ "CARDIOLOGY SJUH", "ST. JAMES'S UNIVERSITY HOSPITAL", "BECKETT STREET" ], "city": "LEEDS", "postalCode": "LS9 7TF", "country": "ENGLAND" }, "managingOrganization": { "reference": "Organization/UKCore-Organization-LeedsTeachingHospital-Example" } }
An example to illustrate Timoptol eye drops medication
Table View
| Medication.id[0] | UKCore-Medication-TimoptolEyeDrops-Example |
| Medication.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication |
| Medication.code[0].coding[0].system[0] | https://dmd.nhs.uk |
| Medication.code[0].coding[0].code[0] | 18616211000001106 |
| Medication.code[0].coding[0].display[0] | Timoptol 0.5% eye drops (DE Pharmaceuticals) |
| Medication.form[0].coding[0].system[0] | http://snomed.info/sct |
| Medication.form[0].coding[0].code[0] | 17960711000001109 |
| Medication.form[0].coding[0].display[0] | Ear/eye drops solution |
| Medication.batch[0].lotNumber[0] | 9494788 |
| Medication.batch[0].expirationDate[0] | 2020-05-22 |
XML View
<Medication xmlns="http://hl7.org/fhir"> <id value="UKCore-Medication-TimoptolEyeDrops-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication" /> </meta> <code> <coding> <system value="https://dmd.nhs.uk" /> <code value="18616211000001106" /> <display value="Timoptol 0.5% eye drops (DE Pharmaceuticals)" /> </coding> </code> <form> <coding> <system value="http://snomed.info/sct" /> <code value="17960711000001109" /> <display value="Ear/eye drops solution" /> </coding> </form> <batch> <lotNumber value="9494788" /> <expirationDate value="2020-05-22" /> </batch> </Medication>
JSON View
{ "resourceType": "Medication", "id": "UKCore-Medication-TimoptolEyeDrops-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication" ] }, "code": { "coding": [ { "system": "https://dmd.nhs.uk", "code": "18616211000001106", "display": "Timoptol 0.5% eye drops (DE Pharmaceuticals)" } ] }, "form": { "coding": [ { "system": "http://snomed.info/sct", "code": "17960711000001109", "display": "Ear/eye drops solution" } ] }, "batch": { "lotNumber": "9494788", "expirationDate": "2020-05-22" } }
An example to illustrate use of Medication Trade Family Extension
Table View
| Medication.id[0] | UKCore-Medication-Extension-MedicationTradeFamily-Example |
| Medication.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily |
| Medication.extension[0].valueCodeableConcept[0].coding[0].system[0] | http://snomed.info/sct |
| Medication.extension[0].valueCodeableConcept[0].coding[0].code[0] | 9298001000001101 |
| Medication.extension[0].valueCodeableConcept[0].coding[0].display[0] | Panadol Extra |
XML View
<Medication xmlns="http://hl7.org/fhir"> <id value="UKCore-Medication-Extension-MedicationTradeFamily-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily"> <valueCodeableConcept> <coding> <system value="http://snomed.info/sct" /> <code value="9298001000001101" /> <display value="Panadol Extra" /> </coding> </valueCodeableConcept> </extension> <!-- **************extension end************** --> </Medication>
JSON View
{ "resourceType": "Medication", "id": "UKCore-Medication-Extension-MedicationTradeFamily-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily", "valueCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "9298001000001101", "display": "Panadol Extra" } ] } } ] }
An example to illustrate an administration of Timoptol eye drops
Table View
| MedicationAdministration.id[0] | UKCore-MedicationAdministration-TimoptolEyeDrops-Example |
| MedicationAdministration.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration |
| MedicationAdministration.identifier[0].system[0] | https://tools.ietf.org/html/rfc4122 |
| MedicationAdministration.identifier[0].value[0] | e8779393-9b7c-4654-a8df-0ba4cc9b28ce |
| MedicationAdministration.status[0] | completed |
| MedicationAdministration.medicationReference[0].reference[0] | Medication/UKCore-Medication-TimoptolEyeDrops-Example |
| MedicationAdministration.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| MedicationAdministration.effectiveDateTime[0] | 2021-03-25T13:00:00+00:00 |
| MedicationAdministration.request[0].reference[0] | MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example |
| MedicationAdministration.dosage[0].text[0] | 1 drop in each affected eye twice daily, approximately 12 hours apart. |
| MedicationAdministration.dosage[0].site[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationAdministration.dosage[0].site[0].coding[0].code[0] | 362508001 |
| MedicationAdministration.dosage[0].site[0].coding[0].display[0] | Both eyes, entire |
| MedicationAdministration.dosage[0].route[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationAdministration.dosage[0].route[0].coding[0].code[0] | 58831000052108 |
| MedicationAdministration.dosage[0].route[0].coding[0].display[0] | Subretinal route |
| MedicationAdministration.dosage[0].method[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationAdministration.dosage[0].method[0].coding[0].code[0] | 421984009 |
| MedicationAdministration.dosage[0].method[0].coding[0].display[0] | Until finished |
| MedicationAdministration.dosage[0].dose[0].value[0] | 30 |
| MedicationAdministration.dosage[0].dose[0].unit[0] | milliliter |
| MedicationAdministration.dosage[0].dose[0].system[0] | http://unitsofmeasure.org |
| MedicationAdministration.dosage[0].dose[0].code[0] | mL |
XML View
<MedicationAdministration xmlns="http://hl7.org/fhir"> <id value="UKCore-MedicationAdministration-TimoptolEyeDrops-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration" /> </meta> <identifier> <system value="https://tools.ietf.org/html/rfc4122" /> <value value="e8779393-9b7c-4654-a8df-0ba4cc9b28ce" /> </identifier> <status value="completed" /> <medicationReference> <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" /> </medicationReference> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <effectiveDateTime value="2021-03-25T13:00:00+00:00" /> <request> <reference value="MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example" /> </request> <dosage> <text value="1 drop in each affected eye twice daily, approximately 12 hours apart." /> <site> <coding> <system value="http://snomed.info/sct" /> <code value="362508001" /> <display value="Both eyes, entire" /> </coding> </site> <route> <coding> <system value="http://snomed.info/sct" /> <code value="58831000052108" /> <display value="Subretinal route" /> </coding> </route> <method> <coding> <system value="http://snomed.info/sct" /> <code value="421984009" /> <display value="Until finished" /> </coding> </method> <dose> <value value="30" /> <unit value="milliliter" /> <system value="http://unitsofmeasure.org" /> <code value="mL" /> </dose> </dosage> </MedicationAdministration>
JSON View
{ "resourceType": "MedicationAdministration", "id": "UKCore-MedicationAdministration-TimoptolEyeDrops-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration" ] }, "identifier": [ { "system": "https://tools.ietf.org/html/rfc4122", "value": "e8779393-9b7c-4654-a8df-0ba4cc9b28ce" } ], "status": "completed", "medicationReference": { "reference": "Medication/UKCore-Medication-TimoptolEyeDrops-Example" }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "effectiveDateTime": "2021-03-25T13:00:00+00:00", "request": { "reference": "MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example" }, "dosage": { "text": "1 drop in each affected eye twice daily, approximately 12 hours apart.", "site": { "coding": [ { "system": "http://snomed.info/sct", "code": "362508001", "display": "Both eyes, entire" } ] }, "route": { "coding": [ { "system": "http://snomed.info/sct", "code": "58831000052108", "display": "Subretinal route" } ] }, "method": { "coding": [ { "system": "http://snomed.info/sct", "code": "421984009", "display": "Until finished" } ] }, "dose": { "value": 30, "unit": "milliliter", "system": "http://unitsofmeasure.org", "code": "mL" } } }
An example to illustrate a medication dispense of eye drops
Table View
| MedicationDispense.id[0] | UKCore-MedicationDispense-EyeDrops-Example |
| MedicationDispense.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationDispense |
| MedicationDispense.identifier[0].system[0] | https://tools.ietf.org/html/rfc4122 |
| MedicationDispense.identifier[0].value[0] | 5c92c1dc-06a9-4729-b8c9-222cf769f8dc |
| MedicationDispense.status[0] | in-progress |
| MedicationDispense.medicationReference[0].reference[0] | Medication/UKCore-Medication-TimoptolEyeDrops-Example |
| MedicationDispense.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| MedicationDispense.performer[0].actor[0].reference[0] | Practitioner/UKCore-Practitioner-PharmacistJimmyChuck-Example |
| MedicationDispense.authorizingPrescription[0].reference[0] | MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example |
| MedicationDispense.quantity[0].value[0] | 30 |
| MedicationDispense.quantity[0].unit[0] | milliliter |
| MedicationDispense.quantity[0].system[0] | http://unitsofmeasure.org |
| MedicationDispense.quantity[0].code[0] | mL |
| MedicationDispense.daysSupply[0].value[0] | 30 |
| MedicationDispense.daysSupply[0].unit[0] | Day |
| MedicationDispense.daysSupply[0].system[0] | http://unitsofmeasure.org |
| MedicationDispense.daysSupply[0].code[0] | d |
| MedicationDispense.whenPrepared[0] | 2020-01-15T15:00:00+00:00 |
| MedicationDispense.receiver[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| MedicationDispense.dosageInstruction[0].text[0] | 1 drop in each affected eye twice daily, approximately 12 hours apart. |
| MedicationDispense.dosageInstruction[0].timing[0].repeat[0].frequency[0] | 1 |
| MedicationDispense.dosageInstruction[0].timing[0].repeat[0].period[0] | 12 |
| MedicationDispense.dosageInstruction[0].timing[0].repeat[0].periodUnit[0] | h |
| MedicationDispense.dosageInstruction[0].site[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationDispense.dosageInstruction[0].site[0].coding[0].code[0] | 362508001 |
| MedicationDispense.dosageInstruction[0].site[0].coding[0].display[0] | Both eyes, entire |
| MedicationDispense.dosageInstruction[0].route[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationDispense.dosageInstruction[0].route[0].coding[0].code[0] | 58831000052108 |
| MedicationDispense.dosageInstruction[0].route[0].coding[0].display[0] | Subretinal route |
| MedicationDispense.dosageInstruction[0].method[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationDispense.dosageInstruction[0].method[0].coding[0].code[0] | 421984009 |
| MedicationDispense.dosageInstruction[0].method[0].coding[0].display[0] | Until finished |
XML View
<MedicationDispense xmlns="http://hl7.org/fhir"> <id value="UKCore-MedicationDispense-EyeDrops-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationDispense" /> </meta> <identifier> <system value="https://tools.ietf.org/html/rfc4122" /> <value value="5c92c1dc-06a9-4729-b8c9-222cf769f8dc" /> </identifier> <status value="in-progress" /> <medicationReference> <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" /> </medicationReference> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <performer> <actor> <reference value="Practitioner/UKCore-Practitioner-PharmacistJimmyChuck-Example" /> </actor> </performer> <authorizingPrescription> <reference value="MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example" /> </authorizingPrescription> <quantity> <value value="30" /> <unit value="milliliter" /> <system value="http://unitsofmeasure.org" /> <code value="mL" /> </quantity> <daysSupply> <value value="30" /> <unit value="Day" /> <system value="http://unitsofmeasure.org" /> <code value="d" /> </daysSupply> <whenPrepared value="2020-01-15T15:00:00+00:00" /> <receiver> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </receiver> <dosageInstruction> <text value="1 drop in each affected eye twice daily, approximately 12 hours apart." /> <timing> <repeat> <frequency value="1" /> <period value="12" /> <periodUnit value="h" /> </repeat> </timing> <site> <coding> <system value="http://snomed.info/sct" /> <code value="362508001" /> <display value="Both eyes, entire" /> </coding> </site> <route> <coding> <system value="http://snomed.info/sct" /> <code value="58831000052108" /> <display value="Subretinal route" /> </coding> </route> <method> <coding> <system value="http://snomed.info/sct" /> <code value="421984009" /> <display value="Until finished" /> </coding> </method> </dosageInstruction> </MedicationDispense>
JSON View
{ "resourceType": "MedicationDispense", "id": "UKCore-MedicationDispense-EyeDrops-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationDispense" ] }, "identifier": [ { "system": "https://tools.ietf.org/html/rfc4122", "value": "5c92c1dc-06a9-4729-b8c9-222cf769f8dc" } ], "status": "in-progress", "medicationReference": { "reference": "Medication/UKCore-Medication-TimoptolEyeDrops-Example" }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "performer": [ { "actor": { "reference": "Practitioner/UKCore-Practitioner-PharmacistJimmyChuck-Example" } } ], "authorizingPrescription": [ { "reference": "MedicationRequest/UKCore-MedicationRequest-EyeDrops-Example" } ], "quantity": { "value": 30, "unit": "milliliter", "system": "http://unitsofmeasure.org", "code": "mL" }, "daysSupply": { "value": 30, "unit": "Day", "system": "http://unitsofmeasure.org", "code": "d" }, "whenPrepared": "2020-01-15T15:00:00+00:00", "receiver": [ { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } ], "dosageInstruction": [ { "text": "1 drop in each affected eye twice daily, approximately 12 hours apart.", "timing": { "repeat": { "frequency": 1, "period": 12, "periodUnit": "h" } }, "site": { "coding": [ { "system": "http://snomed.info/sct", "code": "362508001", "display": "Both eyes, entire" } ] }, "route": { "coding": [ { "system": "http://snomed.info/sct", "code": "58831000052108", "display": "Subretinal route" } ] }, "method": { "coding": [ { "system": "http://snomed.info/sct", "code": "421984009", "display": "Until finished" } ] } } ] }
An example to illustrate a medication request for eye drops
Table View
| MedicationRequest.id[0] | UKCore-MedicationRequest-EyeDrops-Example |
| MedicationRequest.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest |
| MedicationRequest.status[0] | completed |
| MedicationRequest.intent[0] | order |
| MedicationRequest.category[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/medicationrequest-category |
| MedicationRequest.category[0].coding[0].code[0] | outpatient |
| MedicationRequest.category[0].coding[0].display[0] | Outpatient |
| MedicationRequest.priority[0] | routine |
| MedicationRequest.medicationReference[0].reference[0] | Medication/UKCore-Medication-TimoptolEyeDrops-Example |
| MedicationRequest.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| MedicationRequest.authoredOn[0] | 2022-09-10T15:00:00.000Z |
| MedicationRequest.requester[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| MedicationRequest.recorder[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| MedicationRequest.courseOfTherapyType[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy |
| MedicationRequest.courseOfTherapyType[0].coding[0].code[0] | continuous-repeating-dispensing |
| MedicationRequest.courseOfTherapyType[0].coding[0].display[0] | Continuous long term (repeat dispensing) |
| MedicationRequest.dosageInstruction[0].text[0] | 1 drop in each affected eye twice daily, approximately 12 hours apart. |
| MedicationRequest.dosageInstruction[0].timing[0].repeat[0].frequency[0] | 1 |
| MedicationRequest.dosageInstruction[0].timing[0].repeat[0].period[0] | 12 |
| MedicationRequest.dosageInstruction[0].timing[0].repeat[0].periodUnit[0] | h |
| MedicationRequest.dosageInstruction[0].site[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationRequest.dosageInstruction[0].site[0].coding[0].code[0] | 362508001 |
| MedicationRequest.dosageInstruction[0].site[0].coding[0].display[0] | Both eyes, entire |
| MedicationRequest.dosageInstruction[0].method[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationRequest.dosageInstruction[0].method[0].coding[0].code[0] | 421984009 |
| MedicationRequest.dosageInstruction[0].method[0].coding[0].display[0] | Until finished |
| MedicationRequest.substitution[0].allowedBoolean[0] | True |
XML View
<MedicationRequest xmlns="http://hl7.org/fhir"> <id value="UKCore-MedicationRequest-EyeDrops-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest" /> </meta> <status value="completed" /> <intent value="order" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/medicationrequest-category" /> <code value="outpatient" /> <display value="Outpatient" /> </coding> </category> <priority value="routine" /> <medicationReference> <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" /> </medicationReference> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <authoredOn value="2022-09-10T15:00:00.000Z" /> <requester> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </requester> <recorder> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </recorder> <courseOfTherapyType> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy" /> <code value="continuous-repeating-dispensing" /> <display value="Continuous long term (repeat dispensing)" /> </coding> </courseOfTherapyType> <dosageInstruction> <text value="1 drop in each affected eye twice daily, approximately 12 hours apart." /> <timing> <repeat> <frequency value="1" /> <period value="12" /> <periodUnit value="h" /> </repeat> </timing> <site> <coding> <system value="http://snomed.info/sct" /> <code value="362508001" /> <display value="Both eyes, entire" /> </coding> </site> <method> <coding> <system value="http://snomed.info/sct" /> <code value="421984009" /> <display value="Until finished" /> </coding> </method> </dosageInstruction> <substitution> <allowedBoolean value="true" /> </substitution> </MedicationRequest>
JSON View
{ "resourceType": "MedicationRequest", "id": "UKCore-MedicationRequest-EyeDrops-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest" ] }, "status": "completed", "intent": "order", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category", "code": "outpatient", "display": "Outpatient" } ] } ], "priority": "routine", "medicationReference": { "reference": "Medication/UKCore-Medication-TimoptolEyeDrops-Example" }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "authoredOn": "2022-09-10T15:00:00.000Z", "requester": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "recorder": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "courseOfTherapyType": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy", "code": "continuous-repeating-dispensing", "display": "Continuous long term (repeat dispensing)" } ] }, "dosageInstruction": [ { "text": "1 drop in each affected eye twice daily, approximately 12 hours apart.", "timing": { "repeat": { "frequency": 1, "period": 12, "periodUnit": "h" } }, "site": { "coding": [ { "system": "http://snomed.info/sct", "code": "362508001", "display": "Both eyes, entire" } ] }, "method": { "coding": [ { "system": "http://snomed.info/sct", "code": "421984009", "display": "Until finished" } ] } } ], "substitution": { "allowedBoolean": true } }
An example to illustrate whether a pharmacist verified a medication
Table View
| MedicationStatement.id[0] | UKCore-MedicationStatement-Extension-PharmacistVerified-Example |
| MedicationStatement.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement |
| MedicationStatement.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator |
| MedicationStatement.extension[0].valueBoolean[0] | True |
| MedicationStatement.status[0] | active |
| MedicationStatement.medicationCodeableConcept[0].coding[0].system[0] | https://dmd.nhs.uk |
| MedicationStatement.medicationCodeableConcept[0].coding[0].code[0] | 39732311000001104 |
| MedicationStatement.medicationCodeableConcept[0].coding[0].display[0] | Amoxicillin 250mg capsules |
| MedicationStatement.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
XML View
<MedicationStatement xmlns="http://hl7.org/fhir"> <id value="UKCore-MedicationStatement-Extension-PharmacistVerified-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement" /> </meta> <!-- **************extension start************** --> <!-- Pharmacist Verified Indicator extension details --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator"> <valueBoolean value="true" /> </extension> <!-- **************extension end************** --> <status value="active" /> <medicationCodeableConcept> <coding> <system value="https://dmd.nhs.uk" /> <code value="39732311000001104" /> <display value="Amoxicillin 250mg capsules" /> </coding> </medicationCodeableConcept> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> </MedicationStatement>
JSON View
{ "resourceType": "MedicationStatement", "id": "UKCore-MedicationStatement-Extension-PharmacistVerified-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PharmacistVerifiedIndicator", "valueBoolean": true } ], "status": "active", "medicationCodeableConcept": { "coding": [ { "system": "https://dmd.nhs.uk", "code": "39732311000001104", "display": "Amoxicillin 250mg capsules" } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } }
An example to illustrate the specific repeat information of a medication item
Table View
| MedicationRequest.id[0] | UKCore-MedicationRequest-Extension-RepeatInformation-Example |
| MedicationRequest.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest |
| MedicationRequest.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation |
| MedicationRequest.extension[0].extension[0].url[0] | numberOfPrescriptionsIssued |
| MedicationRequest.extension[0].extension[0].valueUnsignedInt[0] | 1 |
| MedicationRequest.extension[0].extension[1].url[0] | authorisationExpiryDate |
| MedicationRequest.extension[0].extension[1].valueDateTime[0] | 2022-09-10T19:00:00.000Z |
| MedicationRequest.status[0] | completed |
| MedicationRequest.intent[0] | order |
| MedicationRequest.category[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/medicationrequest-category |
| MedicationRequest.category[0].coding[0].code[0] | outpatient |
| MedicationRequest.category[0].coding[0].display[0] | Outpatient |
| MedicationRequest.priority[0] | routine |
| MedicationRequest.medicationReference[0].reference[0] | Medication/UKCore-Medication-TimoptolEyeDrops-Example |
| MedicationRequest.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| MedicationRequest.requester[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| MedicationRequest.recorder[0].reference[0] | Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example |
| MedicationRequest.courseOfTherapyType[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy |
| MedicationRequest.courseOfTherapyType[0].coding[0].code[0] | continuous-repeating-dispensing |
| MedicationRequest.courseOfTherapyType[0].coding[0].display[0] | Continuous long term (repeat dispensing) |
| MedicationRequest.dosageInstruction[0].text[0] | 1 drop in each affected eye twice daily, approximately 12 hours apart. |
| MedicationRequest.dosageInstruction[0].timing[0].repeat[0].frequency[0] | 1 |
| MedicationRequest.dosageInstruction[0].timing[0].repeat[0].period[0] | 12 |
| MedicationRequest.dosageInstruction[0].timing[0].repeat[0].periodUnit[0] | h |
| MedicationRequest.dosageInstruction[0].site[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationRequest.dosageInstruction[0].site[0].coding[0].code[0] | 362508001 |
| MedicationRequest.dosageInstruction[0].site[0].coding[0].display[0] | Both eyes, entire |
| MedicationRequest.dosageInstruction[0].method[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationRequest.dosageInstruction[0].method[0].coding[0].code[0] | 421984009 |
| MedicationRequest.dosageInstruction[0].method[0].coding[0].display[0] | Until finished |
| MedicationRequest.substitution[0].allowedBoolean[0] | True |
XML View
<MedicationRequest xmlns="http://hl7.org/fhir"> <id value="UKCore-MedicationRequest-Extension-RepeatInformation-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest" /> </meta> <!-- **************extension start************** --> <!-- MedicationRepeatInformation extension details --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation"> <extension url="numberOfPrescriptionsIssued"> <valueUnsignedInt value="1" /> </extension> <extension url="authorisationExpiryDate"> <valueDateTime value="2022-09-10T19:00:00.000Z" /> </extension> </extension> <!-- **************extension end************** --> <status value="completed" /> <intent value="order" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/medicationrequest-category" /> <code value="outpatient" /> <display value="Outpatient" /> </coding> </category> <priority value="routine" /> <medicationReference> <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" /> </medicationReference> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <requester> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </requester> <recorder> <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" /> </recorder> <courseOfTherapyType> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy" /> <code value="continuous-repeating-dispensing" /> <display value="Continuous long term (repeat dispensing)" /> </coding> </courseOfTherapyType> <dosageInstruction> <text value="1 drop in each affected eye twice daily, approximately 12 hours apart." /> <timing> <repeat> <frequency value="1" /> <period value="12" /> <periodUnit value="h" /> </repeat> </timing> <site> <coding> <system value="http://snomed.info/sct" /> <code value="362508001" /> <display value="Both eyes, entire" /> </coding> </site> <method> <coding> <system value="http://snomed.info/sct" /> <code value="421984009" /> <display value="Until finished" /> </coding> </method> </dosageInstruction> <substitution> <allowedBoolean value="true" /> </substitution> </MedicationRequest>
JSON View
{ "resourceType": "MedicationRequest", "id": "UKCore-MedicationRequest-Extension-RepeatInformation-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation", "extension": [ { "url": "numberOfPrescriptionsIssued", "valueUnsignedInt": 1 }, { "url": "authorisationExpiryDate", "valueDateTime": "2022-09-10T19:00:00.000Z" } ] } ], "status": "completed", "intent": "order", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category", "code": "outpatient", "display": "Outpatient" } ] } ], "priority": "routine", "medicationReference": { "reference": "Medication/UKCore-Medication-TimoptolEyeDrops-Example" }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "requester": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "recorder": { "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" }, "courseOfTherapyType": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationRequestCourseOfTherapy", "code": "continuous-repeating-dispensing", "display": "Continuous long term (repeat dispensing)" } ] }, "dosageInstruction": [ { "text": "1 drop in each affected eye twice daily, approximately 12 hours apart.", "timing": { "repeat": { "frequency": 1, "period": 12, "periodUnit": "h" } }, "site": { "coding": [ { "system": "http://snomed.info/sct", "code": "362508001", "display": "Both eyes, entire" } ] }, "method": { "coding": [ { "system": "http://snomed.info/sct", "code": "421984009", "display": "Until finished" } ] } } ], "substitution": { "allowedBoolean": true } }
An example to illustrate a medication statement for Amoxicillin
Table View
| MedicationStatement.id[0] | UKCore-MedicationStatement-Amoxicillin-Example |
| MedicationStatement.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement |
| MedicationStatement.status[0] | active |
| MedicationStatement.category[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/medication-statement-category |
| MedicationStatement.category[0].coding[0].code[0] | outpatient |
| MedicationStatement.category[0].coding[0].display[0] | Outpatient |
| MedicationStatement.medicationCodeableConcept[0].coding[0].system[0] | https://dmd.nhs.uk |
| MedicationStatement.medicationCodeableConcept[0].coding[0].code[0] | 39732311000001104 |
| MedicationStatement.medicationCodeableConcept[0].coding[0].display[0] | Amoxicillin 250mg capsules |
| MedicationStatement.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| MedicationStatement.effectiveDateTime[0] | 2017-01-23 |
| MedicationStatement.dateAsserted[0] | 2017-02-22 |
| MedicationStatement.reasonCode[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationStatement.reasonCode[0].coding[0].code[0] | 65363002 |
| MedicationStatement.reasonCode[0].coding[0].display[0] | Otitis media |
| MedicationStatement.dosage[0].text[0] | 2 capsules 4 times a day. |
| MedicationStatement.dosage[0].timing[0].repeat[0].frequency[0] | 4 |
| MedicationStatement.dosage[0].timing[0].repeat[0].period[0] | 1 |
| MedicationStatement.dosage[0].timing[0].repeat[0].periodUnit[0] | d |
| MedicationStatement.dosage[0].asNeededCodeableConcept[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationStatement.dosage[0].asNeededCodeableConcept[0].coding[0].code[0] | 16001004 |
| MedicationStatement.dosage[0].asNeededCodeableConcept[0].coding[0].display[0] | Otalgia |
| MedicationStatement.dosage[0].site[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationStatement.dosage[0].site[0].coding[0].code[0] | 123851003 |
| MedicationStatement.dosage[0].site[0].coding[0].display[0] | Mouth region structure |
| MedicationStatement.dosage[0].route[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationStatement.dosage[0].route[0].coding[0].code[0] | 26643006 |
| MedicationStatement.dosage[0].route[0].coding[0].display[0] | Oral |
| MedicationStatement.dosage[0].method[0].coding[0].system[0] | http://snomed.info/sct |
| MedicationStatement.dosage[0].method[0].coding[0].code[0] | 421984009 |
| MedicationStatement.dosage[0].method[0].coding[0].display[0] | Until finished |
| MedicationStatement.dosage[0].doseAndRate[0].doseQuantity[0].value[0] | 500 |
| MedicationStatement.dosage[0].doseAndRate[0].doseQuantity[0].unit[0] | milligram |
| MedicationStatement.dosage[0].doseAndRate[0].doseQuantity[0].system[0] | http://unitsofmeasure.org |
| MedicationStatement.dosage[0].doseAndRate[0].doseQuantity[0].code[0] | mg |
XML View
<MedicationStatement xmlns="http://hl7.org/fhir"> <id value="UKCore-MedicationStatement-Amoxicillin-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement" /> </meta> <status value="active" /> <category> <coding> <system value="http://terminology.hl7.org/CodeSystem/medication-statement-category" /> <code value="outpatient" /> <display value="Outpatient" /> </coding> </category> <medicationCodeableConcept> <coding> <system value="https://dmd.nhs.uk" /> <code value="39732311000001104" /> <display value="Amoxicillin 250mg capsules" /> </coding> </medicationCodeableConcept> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <effectiveDateTime value="2017-01-23" /> <dateAsserted value="2017-02-22" /> <reasonCode> <coding> <system value="http://snomed.info/sct" /> <code value="65363002" /> <display value="Otitis media" /> </coding> </reasonCode> <dosage> <text value="2 capsules 4 times a day." /> <timing> <repeat> <frequency value="4" /> <period value="1" /> <periodUnit value="d" /> </repeat> </timing> <asNeededCodeableConcept> <coding> <system value="http://snomed.info/sct" /> <code value="16001004" /> <display value="Otalgia" /> </coding> </asNeededCodeableConcept> <site> <coding> <system value="http://snomed.info/sct" /> <code value="123851003" /> <display value="Mouth region structure" /> </coding> </site> <route> <coding> <system value="http://snomed.info/sct" /> <code value="26643006" /> <display value="Oral" /> </coding> </route> <method> <coding> <system value="http://snomed.info/sct" /> <code value="421984009" /> <display value="Until finished" /> </coding> </method> <doseAndRate> <doseQuantity> <value value="500" /> <unit value="milligram" /> <system value="http://unitsofmeasure.org" /> <code value="mg" /> </doseQuantity> </doseAndRate> </dosage> </MedicationStatement>
JSON View
{ "resourceType": "MedicationStatement", "id": "UKCore-MedicationStatement-Amoxicillin-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement" ] }, "status": "active", "category": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/medication-statement-category", "code": "outpatient", "display": "Outpatient" } ] }, "medicationCodeableConcept": { "coding": [ { "system": "https://dmd.nhs.uk", "code": "39732311000001104", "display": "Amoxicillin 250mg capsules" } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "effectiveDateTime": "2017-01-23", "dateAsserted": "2017-02-22", "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "65363002", "display": "Otitis media" } ] } ], "dosage": [ { "text": "2 capsules 4 times a day.", "timing": { "repeat": { "frequency": 4, "period": 1, "periodUnit": "d" } }, "asNeededCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "16001004", "display": "Otalgia" } ] }, "site": { "coding": [ { "system": "http://snomed.info/sct", "code": "123851003", "display": "Mouth region structure" } ] }, "route": { "coding": [ { "system": "http://snomed.info/sct", "code": "26643006", "display": "Oral" } ] }, "method": { "coding": [ { "system": "http://snomed.info/sct", "code": "421984009", "display": "Until finished" } ] }, "doseAndRate": [ { "doseQuantity": { "value": 500, "unit": "milligram", "system": "http://unitsofmeasure.org", "code": "mg" } } ] } ] }
An example to illustrate the date when a prescription was last issued
Table View
| MedicationStatement.id[0] | UKCore-MedicationStatement-Extension-LastIssueDate-Example |
| MedicationStatement.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement |
| MedicationStatement.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate |
| MedicationStatement.extension[0].valueDateTime[0] | 2017-02-24 |
| MedicationStatement.status[0] | active |
| MedicationStatement.medicationCodeableConcept[0].coding[0].system[0] | https://dmd.nhs.uk |
| MedicationStatement.medicationCodeableConcept[0].coding[0].code[0] | 39732311000001104 |
| MedicationStatement.medicationCodeableConcept[0].coding[0].display[0] | Amoxicillin 250mg capsules |
| MedicationStatement.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
XML View
<MedicationStatement xmlns="http://hl7.org/fhir"> <id value="UKCore-MedicationStatement-Extension-LastIssueDate-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement" /> </meta> <!-- **************extension start************** --> <!-- MedicationStatement Last Issue Date extension details --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate"> <valueDateTime value="2017-02-24" /> </extension> <!-- **************extension end************** --> <status value="active" /> <medicationCodeableConcept> <coding> <system value="https://dmd.nhs.uk" /> <code value="39732311000001104" /> <display value="Amoxicillin 250mg capsules" /> </coding> </medicationCodeableConcept> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> </MedicationStatement>
JSON View
{ "resourceType": "MedicationStatement", "id": "UKCore-MedicationStatement-Extension-LastIssueDate-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationStatementLastIssueDate", "valueDateTime": "2017-02-24" } ], "status": "active", "medicationCodeableConcept": { "coding": [ { "system": "https://dmd.nhs.uk", "code": "39732311000001104", "display": "Amoxicillin 250mg capsules" } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } }
An example to illustrate the type of organisation or setting responsible for authorising and issuing a medication, but not the organisation or setting delivering the patient care
Table View
| MedicationStatement.id[0] | UKCore-MedicationStatement-Extension-PrescribingOrg-Example |
| MedicationStatement.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement |
| MedicationStatement.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganizationType |
| MedicationStatement.extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationPrescribingOrganization |
| MedicationStatement.extension[0].valueCodeableConcept[0].coding[0].code[0] | prescribed-at-gp-practice |
| MedicationStatement.extension[0].valueCodeableConcept[0].coding[0].display[0] | Prescribed at GP practice |
| MedicationStatement.status[0] | active |
| MedicationStatement.medicationCodeableConcept[0].coding[0].system[0] | https://dmd.nhs.uk |
| MedicationStatement.medicationCodeableConcept[0].coding[0].code[0] | 39732311000001104 |
| MedicationStatement.medicationCodeableConcept[0].coding[0].display[0] | Amoxicillin 250mg capsules |
| MedicationStatement.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
XML View
<MedicationStatement xmlns="http://hl7.org/fhir"> <id value="UKCore-MedicationStatement-Extension-PrescribingOrg-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement" /> </meta> <!-- **************extension start************** --> <!-- Medication Prescribing Organization extension details --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganizationType"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationPrescribingOrganization" /> <code value="prescribed-at-gp-practice" /> <display value="Prescribed at GP practice" /> </coding> </valueCodeableConcept> </extension> <!-- **************extension end************** --> <status value="active" /> <medicationCodeableConcept> <coding> <system value="https://dmd.nhs.uk" /> <code value="39732311000001104" /> <display value="Amoxicillin 250mg capsules" /> </coding> </medicationCodeableConcept> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> </MedicationStatement>
JSON View
{ "resourceType": "MedicationStatement", "id": "UKCore-MedicationStatement-Extension-PrescribingOrg-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationPrescribingOrganizationType", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-MedicationPrescribingOrganization", "code": "prescribed-at-gp-practice", "display": "Prescribed at GP practice" } ] } } ], "status": "active", "medicationCodeableConcept": { "coding": [ { "system": "https://dmd.nhs.uk", "code": "39732311000001104", "display": "Amoxicillin 250mg capsules" } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" } }
An example to illustrate an Organisation's main location
Table View
| Organization.id[0] | UKCore-Organization-Extension-MainLocation-Example |
| Organization.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation |
| Organization.extension[0].valueReference[0].reference[0] | Location/UKCore-Location-HospitalSJUH-Example |
| Organization.extension[0].valueReference[0].type[0] | Location |
| Organization.extension[0].valueReference[0].identifier[0].use[0] | official |
| Organization.extension[0].valueReference[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-site-code |
| Organization.extension[0].valueReference[0].identifier[0].value[0] | RR813 |
| Organization.identifier[0].use[0] | official |
| Organization.identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
| Organization.identifier[0].value[0] | RR8 |
| Organization.name[0] | LEEDS TEACHING HOSPITALS NHS TRUST |
XML View
<Organization xmlns="http://hl7.org/fhir"> <id value="UKCore-Organization-Extension-MainLocation-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation"> <valueReference> <reference value="Location/UKCore-Location-HospitalSJUH-Example" /> <type value="Location" /> <identifier> <use value="official" /> <system value="https://fhir.nhs.uk/Id/ods-site-code" /> <value value="RR813" /> </identifier> </valueReference> </extension> <!-- *************extension end ***************** --> <identifier> <use value="official" /> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="RR8" /> </identifier> <name value="LEEDS TEACHING HOSPITALS NHS TRUST" /> </Organization>
JSON View
{ "resourceType": "Organization", "id": "UKCore-Organization-Extension-MainLocation-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation", "valueReference": { "reference": "Location/UKCore-Location-HospitalSJUH-Example", "type": "Location", "identifier": { "use": "official", "system": "https://fhir.nhs.uk/Id/ods-site-code", "value": "RR813" } } } ], "identifier": [ { "use": "official", "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RR8" } ], "name": "LEEDS TEACHING HOSPITALS NHS TRUST" }
An example to illustrate the Care setting of a FHIR Document Organisation's
Table View
| Composition.id[0] | UKCore-Composition-Extension-CareSettingType-Example |
| Composition.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType |
| Composition.extension[0].valueCodeableConcept[0].coding[0].system[0] | http://snomed.info/sct |
| Composition.extension[0].valueCodeableConcept[0].coding[0].code[0] | 789718008 |
| Composition.extension[0].valueCodeableConcept[0].coding[0].display[0] | Cardiology service |
| Composition.status[0] | final |
| Composition.type[0].coding[0].system[0] | http://snomed.info/sct |
| Composition.type[0].coding[0].code[0] | 373942005 |
| Composition.type[0].coding[0].display[0] | Discharge summary |
| Composition.date[0] | 2020-11-11T21:30:00+00:00 |
| Composition.author[0].reference[0] | urn:uuid:6555b7a7-380d-46ff-a1c5-7abc4e68f8bc |
| Composition.title[0] | Discharge summary |
XML View
<Composition xmlns="http://hl7.org/fhir"> <id value="UKCore-Composition-Extension-CareSettingType-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType"> <valueCodeableConcept> <coding> <system value="http://snomed.info/sct" /> <code value="789718008" /> <display value="Cardiology service" /> </coding> </valueCodeableConcept> </extension> <!-- *************extension end ***************** --> <status value="final" /> <type> <!-- Discharge Summary document type --> <coding> <system value="http://snomed.info/sct" /> <code value="373942005" /> <display value="Discharge summary" /> </coding> </type> <date value="2020-11-11T21:30:00+00:00" /> <author> <reference value="urn:uuid:6555b7a7-380d-46ff-a1c5-7abc4e68f8bc" /> </author> <title value="Discharge summary" /> </Composition>
JSON View
{ "resourceType": "Composition", "id": "UKCore-Composition-Extension-CareSettingType-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType", "valueCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "789718008", "display": "Cardiology service" } ] } } ], "status": "final", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "373942005", "display": "Discharge summary" } ] }, "date": "2020-11-11T21:30:00+00:00", "author": [ { "reference": "urn:uuid:6555b7a7-380d-46ff-a1c5-7abc4e68f8bc" } ], "title": "Discharge summary" }
An example to illustrate an error returned due to a error in a date
Table View
| OperationOutcome.id[0] | UKCore-OperationOutcome-DateError-Example |
| OperationOutcome.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome |
| OperationOutcome.issue[0].severity[0] | fatal |
| OperationOutcome.issue[0].code[0] | structure |
| OperationOutcome.issue[0].details[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/operation-outcome |
| OperationOutcome.issue[0].details[0].coding[0].code[0] | MSG_DATE_FORMAT |
| OperationOutcome.issue[0].details[0].coding[0].display[0] | The Date value %s is not in the correct format (Xml Date Format required) |
| OperationOutcome.issue[0].diagnostics[0] | Interop.FHIRProcessors.Patient.processbirthDate line 2450 |
| OperationOutcome.issue[0].expression[0] | Patient.birthDate |
XML View
<OperationOutcome xmlns="http://hl7.org/fhir"> <id value="UKCore-OperationOutcome-DateError-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome" /> </meta> <issue> <severity value="fatal" /> <code value="structure" /> <details> <coding> <system value="http://terminology.hl7.org/CodeSystem/operation-outcome" /> <code value="MSG_DATE_FORMAT" /> <display value="The Date value %s is not in the correct format (Xml Date Format required)" /> </coding> </details> <diagnostics value="Interop.FHIRProcessors.Patient.processbirthDate line 2450" /> <expression value="Patient.birthDate" /> </issue> </OperationOutcome>
JSON View
{ "resourceType": "OperationOutcome", "id": "UKCore-OperationOutcome-DateError-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome" ] }, "issue": [ { "severity": "fatal", "code": "structure", "details": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/operation-outcome", "code": "MSG_DATE_FORMAT", "display": "The Date value %s is not in the correct format (Xml Date Format required)" } ] }, "diagnostics": "Interop.FHIRProcessors.Patient.processbirthDate line 2450", "expression": [ "Patient.birthDate" ] } ] }
An example to illustrate a general practice organisation
Table View
| Organization.id[0] | UKCore-Organization-WhiteRoseMedicalCentre-Example |
| Organization.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization |
| Organization.identifier[0].use[0] | official |
| Organization.identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
| Organization.identifier[0].value[0] | GP5 |
| Organization.name[0] | WHITE ROSE MEDICAL CENTRE |
| Organization.telecom[0].system[0] | phone |
| Organization.telecom[0].value[0] | 0111 243 3144 |
| Organization.address[0].line[0] | WHITE ROSE MEDICAL PRACTICE |
| Organization.address[0].line[1] | ROSE STREET |
| Organization.address[0].city[0] | LEEDS |
| Organization.address[0].postalCode[0] | LS1288T |
| Organization.address[0].country[0] | ENGLAND |
XML View
<Organization xmlns="http://hl7.org/fhir"> <id value="UKCore-Organization-WhiteRoseMedicalCentre-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> </meta> <identifier> <use value="official" /> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="GP5" /> </identifier> <name value="WHITE ROSE MEDICAL CENTRE" /> <telecom> <system value="phone" /> <value value="0111 243 3144" /> </telecom> <address> <line value="WHITE ROSE MEDICAL PRACTICE" /> <line value="ROSE STREET" /> <city value="LEEDS" /> <postalCode value="LS1288T" /> <country value="ENGLAND" /> </address> </Organization>
JSON View
{ "resourceType": "Organization", "id": "UKCore-Organization-WhiteRoseMedicalCentre-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" ] }, "identifier": [ { "use": "official", "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "GP5" } ], "name": "WHITE ROSE MEDICAL CENTRE", "telecom": [ { "system": "phone", "value": "0111 243 3144" } ], "address": [ { "line": [ "WHITE ROSE MEDICAL PRACTICE", "ROSE STREET" ], "city": "LEEDS", "postalCode": "LS1288T", "country": "ENGLAND" } ] }
An example to illustrate an hospital organisation
Table View
| Organization.id[0] | UKCore-Organization-LeedsTeachingHospital-Example |
| Organization.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization |
| Organization.identifier[0].use[0] | official |
| Organization.identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
| Organization.identifier[0].value[0] | RR8 |
| Organization.name[0] | LEEDS TEACHING HOSPITALS NHS TRUST |
| Organization.telecom[0].system[0] | phone |
| Organization.telecom[0].value[0] | 0113 243 3144 |
| Organization.address[0].line[0] | ST. JAMES'S UNIVERSITY HOSPITAL |
| Organization.address[0].line[1] | BECKETT STREET |
| Organization.address[0].city[0] | LEEDS |
| Organization.address[0].postalCode[0] | LS9 7TF |
| Organization.address[0].country[0] | ENGLAND |
XML View
<Organization xmlns="http://hl7.org/fhir"> <id value="UKCore-Organization-LeedsTeachingHospital-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> </meta> <identifier> <use value="official" /> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="RR8" /> </identifier> <name value="LEEDS TEACHING HOSPITALS NHS TRUST" /> <telecom> <system value="phone" /> <value value="0113 243 3144" /> </telecom> <address> <line value="ST. JAMES'S UNIVERSITY HOSPITAL" /> <line value="BECKETT STREET" /> <city value="LEEDS" /> <postalCode value="LS9 7TF" /> <country value="ENGLAND" /> </address> </Organization>
JSON View
{ "resourceType": "Organization", "id": "UKCore-Organization-LeedsTeachingHospital-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" ] }, "identifier": [ { "use": "official", "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RR8" } ], "name": "LEEDS TEACHING HOSPITALS NHS TRUST", "telecom": [ { "system": "phone", "value": "0113 243 3144" } ], "address": [ { "line": [ "ST. JAMES'S UNIVERSITY HOSPITAL", "BECKETT STREET" ], "city": "LEEDS", "postalCode": "LS9 7TF", "country": "ENGLAND" } ] }
An example to illustrate the extension which shows an organsation's main location
Table View
| Organization.id[0] | UKCore-Organization-Extension-MainLocation-Example |
| Organization.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation |
| Organization.extension[0].valueReference[0].reference[0] | Location/UKCore-Location-HospitalSJUH-Example |
| Organization.extension[0].valueReference[0].type[0] | Location |
| Organization.extension[0].valueReference[0].identifier[0].use[0] | official |
| Organization.extension[0].valueReference[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-site-code |
| Organization.extension[0].valueReference[0].identifier[0].value[0] | RR813 |
| Organization.identifier[0].use[0] | official |
| Organization.identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
| Organization.identifier[0].value[0] | RR8 |
| Organization.name[0] | LEEDS TEACHING HOSPITALS NHS TRUST |
XML View
<Organization xmlns="http://hl7.org/fhir"> <id value="UKCore-Organization-Extension-MainLocation-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation"> <valueReference> <reference value="Location/UKCore-Location-HospitalSJUH-Example" /> <type value="Location" /> <identifier> <use value="official" /> <system value="https://fhir.nhs.uk/Id/ods-site-code" /> <value value="RR813" /> </identifier> </valueReference> </extension> <!-- *************extension end ***************** --> <identifier> <use value="official" /> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="RR8" /> </identifier> <name value="LEEDS TEACHING HOSPITALS NHS TRUST" /> </Organization>
JSON View
{ "resourceType": "Organization", "id": "UKCore-Organization-Extension-MainLocation-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation", "valueReference": { "reference": "Location/UKCore-Location-HospitalSJUH-Example", "type": "Location", "identifier": { "use": "official", "system": "https://fhir.nhs.uk/Id/ods-site-code", "value": "RR813" } } } ], "identifier": [ { "use": "official", "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RR8" } ], "name": "LEEDS TEACHING HOSPITALS NHS TRUST" }
An example to illustrate the extension for address key for a patient
Table View
| Patient.id[0] | UKCore-Patient-Extension-AddressKey-Example |
| Patient.address[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey |
| Patient.address[0].extension[0].extension[0].url[0] | type |
| Patient.address[0].extension[0].extension[0].valueCoding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType |
| Patient.address[0].extension[0].extension[0].valueCoding[0].code[0] | PAF |
| Patient.address[0].extension[0].extension[0].valueCoding[0].display[0] | Postcode Address File |
| Patient.address[0].extension[0].extension[1].url[0] | value |
| Patient.address[0].extension[0].extension[1].valueString[0] | LS10ABC |
| Patient.address[0].line[0] | 4 Sandmoor Drive |
| Patient.address[0].city[0] | LEEDS |
| Patient.address[0].postalCode[0] | LS17 7DF |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-AddressKey-Example" /> <address> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"> <extension url="type"> <valueCoding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" /> <code value="PAF" /> <display value="Postcode Address File" /> </valueCoding> </extension> <extension url="value"> <valueString value="LS10ABC" /> </extension> </extension> <line value="4 Sandmoor Drive" /> <city value="LEEDS" /> <postalCode value="LS17 7DF" /> <!-- *************extension end ***************** --> </address> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-AddressKey-Example", "address": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey", "extension": [ { "url": "type", "valueCoding": { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType", "code": "PAF", "display": "Postcode Address File" } }, { "url": "value", "valueString": "LS10ABC" } ] } ], "line": [ "4 Sandmoor Drive" ], "city": "LEEDS", "postalCode": "LS17 7DF" } ] }
An example to illustrate a patient's contact ranking
Table View
| Patient.id[0] | UKCore-Patient-Extension-ContactRank-Example |
| Patient.contact[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank |
| Patient.contact[0].extension[0].valuePositiveInt[0] | 1 |
| Patient.contact[0].name[0].use[0] | official |
| Patient.contact[0].name[0].family[0] | CARTER |
| Patient.contact[0].name[0].given[0] | Emily |
| Patient.contact[0].telecom[0].system[0] | phone |
| Patient.contact[0].telecom[0].value[0] | 01131231288 |
| Patient.contact[0].gender[0] | female |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-ContactRank-Example" /> <contact> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"> <valuePositiveInt value="1" /> </extension> <!-- **************extension end************** --> <name> <use value="official" /> <family value="CARTER" /> <given value="Emily" /> </name> <telecom> <system value="phone" /> <value value="01131231288" /> </telecom> <gender value="female" /> </contact> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-ContactRank-Example", "contact": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank", "valuePositiveInt": 1 } ], "name": { "use": "official", "family": "CARTER", "given": [ "Emily" ] }, "telecom": [ { "system": "phone", "value": "01131231288" } ], "gender": "female" } ] }
An example to illustrate a patient called Richard Smith
Table View
| Patient.id[0] | UKCore-Patient-RichardSmith-Example |
| Patient.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient |
| Patient.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory |
| Patient.extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland |
| Patient.extension[0].valueCodeableConcept[0].coding[0].code[0] | G |
| Patient.extension[0].valueCodeableConcept[0].coding[0].display[0] | Mixed - Any other mixed background |
| Patient.extension[1].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
| Patient.extension[1].extension[0].url[0] | PreferredContactMethod |
| Patient.extension[1].extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod |
| Patient.extension[1].extension[0].valueCodeableConcept[0].coding[0].code[0] | 3 |
| Patient.extension[1].extension[0].valueCodeableConcept[0].coding[0].display[0] | Telephone |
| Patient.extension[1].extension[1].url[0] | PreferredContactTimes |
| Patient.extension[1].extension[1].valueTiming[0].repeat[0].frequency[0] | 1 |
| Patient.extension[1].extension[1].valueTiming[0].repeat[0].period[0] | 1 |
| Patient.extension[1].extension[1].valueTiming[0].repeat[0].periodUnit[0] | d |
| Patient.extension[1].extension[1].valueTiming[0].repeat[0].dayOfWeek[0] | mon |
| Patient.extension[1].extension[1].valueTiming[0].repeat[0].dayOfWeek[1] | wed |
| Patient.extension[1].extension[1].valueTiming[0].repeat[0].dayOfWeek[2] | fri |
| Patient.extension[1].extension[1].valueTiming[0].repeat[0].when[0] | MORN |
| Patient.extension[1].extension[2].url[0] | PreferredWrittenCommunicationFormat |
| Patient.extension[1].extension[2].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat |
| Patient.extension[1].extension[2].valueCodeableConcept[0].coding[0].code[0] | 11 |
| Patient.extension[1].extension[2].valueCodeableConcept[0].coding[0].display[0] | Large print |
| Patient.extension[2].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus |
| Patient.extension[2].extension[0].url[0] | deathNotificationStatus |
| Patient.extension[2].extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus |
| Patient.extension[2].extension[0].valueCodeableConcept[0].coding[0].code[0] | U |
| Patient.extension[2].extension[0].valueCodeableConcept[0].coding[0].display[0] | Removed |
| Patient.extension[2].extension[1].url[0] | systemEffectiveDate |
| Patient.extension[2].extension[1].valueDateTime[0] | 2019-08-01T00:00:00.000Z |
| Patient.extension[3].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus |
| Patient.extension[3].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus |
| Patient.extension[3].valueCodeableConcept[0].coding[0].code[0] | H |
| Patient.extension[3].valueCodeableConcept[0].coding[0].display[0] | UK Resident |
| Patient.identifier[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus |
| Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus |
| Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].code[0] | number-present-and-verified |
| Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].display[0] | Number present and verified |
| Patient.identifier[0].system[0] | https://fhir.nhs.uk/Id/nhs-number |
| Patient.identifier[0].value[0] | 9912003888 |
| Patient.name[0].use[0] | official |
| Patient.name[0].family[0] | SMITH |
| Patient.name[0].given[0] | Richard |
| Patient.telecom[0].system[0] | phone |
| Patient.telecom[0].value[0] | 01131231234 |
| Patient.gender[0] | male |
| Patient.birthDate[0] | 1970-09-11 |
| Patient.birthDate[0].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/patient-birthTime |
| Patient.birthDate[0].extension[0].valueDateTime[0] | 1970-09-11T13:46:00+00:00 |
| Patient.address[0].line[0] | 4 Sandmoor Drive |
| Patient.address[0].line[1] | LEEDS |
| Patient.address[0].postalCode[0] | LS17 7DF |
| Patient.contact[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank |
| Patient.contact[0].extension[0].valuePositiveInt[0] | 1 |
| Patient.contact[0].extension[1].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
| Patient.contact[0].extension[1].valueBoolean[0] | True |
| Patient.contact[0].relationship[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole |
| Patient.contact[0].relationship[0].coding[0].code[0] | Personal |
| Patient.contact[0].relationship[0].coding[0].display[0] | Personal relationship with the patient |
| Patient.contact[0].name[0].use[0] | official |
| Patient.contact[0].name[0].text[0] | JACKSON Jane (Miss) |
| Patient.contact[0].name[0].family[0] | Jackson |
| Patient.contact[0].name[0].given[0] | Jane |
| Patient.contact[0].name[0].prefix[0] | Miss |
| Patient.contact[0].telecom[0].system[0] | phone |
| Patient.contact[0].telecom[0].value[0] | 07777123123 |
| Patient.contact[0].telecom[0].use[0] | mobile |
| Patient.contact[0].address[0].use[0] | home |
| Patient.contact[0].address[0].type[0] | physical |
| Patient.contact[0].address[0].line[0] | 5 Alwoodley Road |
| Patient.contact[0].address[0].line[1] | LEEDS |
| Patient.contact[0].address[0].postalCode[0] | LS17 6EH |
| Patient.contact[0].gender[0] | female |
| Patient.communication[0].language[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage |
| Patient.communication[0].language[0].coding[0].code[0] | en |
| Patient.communication[0].language[0].coding[0].display[0] | English |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-RichardSmith-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" /> </meta> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland" /> <code value="G" /> <display value="Mixed - Any other mixed background" /> </coding> </valueCodeableConcept> </extension> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"> <extension url="PreferredContactMethod"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod" /> <code value="3" /> <display value="Telephone" /> </coding> </valueCodeableConcept> </extension> <extension url="PreferredContactTimes"> <valueTiming> <repeat> <frequency value="1" /> <period value="1" /> <periodUnit value="d" /> <dayOfWeek value="mon" /> <dayOfWeek value="wed" /> <dayOfWeek value="fri" /> <when value="MORN" /> </repeat> </valueTiming> </extension> <extension url="PreferredWrittenCommunicationFormat"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat" /> <code value="11" /> <display value="Large print" /> </coding> </valueCodeableConcept> </extension> </extension> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus"> <extension url="deathNotificationStatus"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus" /> <code value="U" /> <display value="Removed" /> </coding> </valueCodeableConcept> </extension> <extension url="systemEffectiveDate"> <valueDateTime value="2019-08-01T00:00:00.000Z" /> </extension> </extension> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus" /> <code value="H" /> <display value="UK Resident" /> </coding> </valueCodeableConcept> </extension> <identifier> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" /> <code value="number-present-and-verified" /> <display value="Number present and verified" /> </coding> </valueCodeableConcept> </extension> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9912003888" /> </identifier> <name> <use value="official" /> <family value="SMITH" /> <given value="Richard" /> </name> <telecom> <system value="phone" /> <value value="01131231234" /> </telecom> <gender value="male" /> <birthDate value="1970-09-11"> <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime"> <valueDateTime value="1970-09-11T13:46:00+00:00" /> </extension> </birthDate> <address> <line value="4 Sandmoor Drive" /> <line value="LEEDS" /> <postalCode value="LS17 7DF" /> </address> <contact> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"> <valuePositiveInt value="1" /> </extension> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator"> <valueBoolean value="true" /> </extension> <relationship> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole" /> <code value="Personal" /> <display value="Personal relationship with the patient" /> </coding> </relationship> <name> <use value="official" /> <text value="JACKSON Jane (Miss)" /> <family value="Jackson" /> <given value="Jane" /> <prefix value="Miss" /> </name> <telecom> <system value="phone" /> <value value="07777123123" /> <use value="mobile" /> </telecom> <address> <use value="home" /> <type value="physical" /> <line value="5 Alwoodley Road" /> <line value="LEEDS" /> <postalCode value="LS17 6EH" /> </address> <gender value="female" /> </contact> <communication> <language> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage" /> <code value="en" /> <display value="English" /> </coding> </language> </communication> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-RichardSmith-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland", "code": "G", "display": "Mixed - Any other mixed background" } ] } }, { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference", "extension": [ { "url": "PreferredContactMethod", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod", "code": "3", "display": "Telephone" } ] } }, { "url": "PreferredContactTimes", "valueTiming": { "repeat": { "frequency": 1, "period": 1, "periodUnit": "d", "dayOfWeek": [ "mon", "wed", "fri" ], "when": [ "MORN" ] } } }, { "url": "PreferredWrittenCommunicationFormat", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat", "code": "11", "display": "Large print" } ] } } ] }, { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus", "extension": [ { "url": "deathNotificationStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus", "code": "U", "display": "Removed" } ] } }, { "url": "systemEffectiveDate", "valueDateTime": "2019-08-01T00:00:00.000Z" } ] }, { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus", "code": "H", "display": "UK Resident" } ] } } ], "identifier": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus", "code": "number-present-and-verified", "display": "Number present and verified" } ] } } ], "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9912003888" } ], "name": [ { "use": "official", "family": "SMITH", "given": [ "Richard" ] } ], "telecom": [ { "system": "phone", "value": "01131231234" } ], "gender": "male", "birthDate": "1970-09-11", "_birthDate": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime", "valueDateTime": "1970-09-11T13:46:00+00:00" } ] }, "address": [ { "line": [ "4 Sandmoor Drive", "LEEDS" ], "postalCode": "LS17 7DF" } ], "contact": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank", "valuePositiveInt": 1 }, { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator", "valueBoolean": true } ], "relationship": [ { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole", "code": "Personal", "display": "Personal relationship with the patient" } ] } ], "name": { "use": "official", "text": "JACKSON Jane (Miss)", "family": "Jackson", "given": [ "Jane" ], "prefix": [ "Miss" ] }, "telecom": [ { "system": "phone", "value": "07777123123", "use": "mobile" } ], "address": { "use": "home", "type": "physical", "line": [ "5 Alwoodley Road", "LEEDS" ], "postalCode": "LS17 6EH" }, "gender": "female" } ], "communication": [ { "language": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage", "code": "en", "display": "English" } ] } } ] }
An example to illustrate a baby patient
Table View
| Patient.id[0] | UKCore-Patient-BabyPatient-Example |
| Patient.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient |
| Patient.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory |
| Patient.extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland |
| Patient.extension[0].valueCodeableConcept[0].coding[0].code[0] | A |
| Patient.extension[0].valueCodeableConcept[0].coding[0].display[0] | White - British |
| Patient.identifier[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus |
| Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus |
| Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].code[0] | number-present-and-verified |
| Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].display[0] | Number present and verified |
| Patient.identifier[0].system[0] | https://fhir.nhs.uk/Id/nhs-number |
| Patient.identifier[0].value[0] | 9912003890 |
| Patient.name[0].use[0] | official |
| Patient.name[0].family[0] | JONES |
| Patient.name[0].given[0] | Melanie |
| Patient.telecom[0].system[0] | phone |
| Patient.telecom[0].value[0] | 01131231266 |
| Patient.gender[0] | female |
| Patient.birthDate[0] | 2021-02-11 |
| Patient.birthDate[0].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/patient-birthTime |
| Patient.birthDate[0].extension[0].valueDateTime[0] | 2021-02-11T15:39:00+00:00 |
| Patient.address[0].line[0] | 10 Fearnville Grove |
| Patient.address[0].line[1] | LEEDS |
| Patient.address[0].postalCode[0] | LS8 3DR |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-BabyPatient-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" /> </meta> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland" /> <code value="A" /> <display value="White - British" /> </coding> </valueCodeableConcept> </extension> <identifier> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" /> <code value="number-present-and-verified" /> <display value="Number present and verified" /> </coding> </valueCodeableConcept> </extension> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9912003890" /> </identifier> <name> <use value="official" /> <family value="JONES" /> <given value="Melanie" /> </name> <telecom> <system value="phone" /> <value value="01131231266" /> </telecom> <gender value="female" /> <birthDate value="2021-02-11"> <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime"> <valueDateTime value="2021-02-11T15:39:00+00:00" /> </extension> </birthDate> <address> <line value="10 Fearnville Grove" /> <line value="LEEDS" /> <postalCode value="LS8 3DR" /> </address> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-BabyPatient-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland", "code": "A", "display": "White - British" } ] } } ], "identifier": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus", "code": "number-present-and-verified", "display": "Number present and verified" } ] } } ], "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9912003890" } ], "name": [ { "use": "official", "family": "JONES", "given": [ "Melanie" ] } ], "telecom": [ { "system": "phone", "value": "01131231266" } ], "gender": "female", "birthDate": "2021-02-11", "_birthDate": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime", "valueDateTime": "2021-02-11T15:39:00+00:00" } ] }, "address": [ { "line": [ "10 Fearnville Grove", "LEEDS" ], "postalCode": "LS8 3DR" } ] }
An example to illustrate the extension for a patient's contact preferences
Table View
| Patient.id[0] | UKCore-Patient-Extension-ContactPreference-Example |
| Patient.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
| Patient.extension[0].extension[0].url[0] | PreferredContactMethod |
| Patient.extension[0].extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod |
| Patient.extension[0].extension[0].valueCodeableConcept[0].coding[0].code[0] | 3 |
| Patient.extension[0].extension[0].valueCodeableConcept[0].coding[0].display[0] | Telephone |
| Patient.extension[0].extension[1].url[0] | PreferredContactTimes |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].frequency[0] | 1 |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].period[0] | 1 |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].periodUnit[0] | d |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[0] | mon |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[1] | wed |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[2] | fri |
| Patient.extension[0].extension[1].valueTiming[0].repeat[0].when[0] | MORN |
| Patient.extension[0].extension[2].url[0] | PreferredWrittenCommunicationFormat |
| Patient.extension[0].extension[2].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat |
| Patient.extension[0].extension[2].valueCodeableConcept[0].coding[0].code[0] | 11 |
| Patient.extension[0].extension[2].valueCodeableConcept[0].coding[0].display[0] | Large print |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-ContactPreference-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"> <extension url="PreferredContactMethod"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod" /> <code value="3" /> <display value="Telephone" /> </coding> </valueCodeableConcept> </extension> <extension url="PreferredContactTimes"> <valueTiming> <repeat> <frequency value="1" /> <period value="1" /> <periodUnit value="d" /> <dayOfWeek value="mon" /> <dayOfWeek value="wed" /> <dayOfWeek value="fri" /> <when value="MORN" /> </repeat> </valueTiming> </extension> <extension url="PreferredWrittenCommunicationFormat"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat" /> <code value="11" /> <display value="Large print" /> </coding> </valueCodeableConcept> </extension> </extension> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-ContactPreference-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference", "extension": [ { "url": "PreferredContactMethod", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod", "code": "3", "display": "Telephone" } ] } }, { "url": "PreferredContactTimes", "valueTiming": { "repeat": { "frequency": 1, "period": 1, "periodUnit": "d", "dayOfWeek": [ "mon", "wed", "fri" ], "when": [ "MORN" ] } } }, { "url": "PreferredWrittenCommunicationFormat", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat", "code": "11", "display": "Large print" } ] } } ] } ] }
An example to illustrate the extension to indicate the death notification status of the patient
Table View
| Patient.id[0] | UKCore-Patient-Extension-DeathNotificationStatus-Example |
| Patient.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus |
| Patient.extension[0].extension[0].url[0] | deathNotificationStatus |
| Patient.extension[0].extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus |
| Patient.extension[0].extension[0].valueCodeableConcept[0].coding[0].code[0] | U |
| Patient.extension[0].extension[0].valueCodeableConcept[0].coding[0].display[0] | Removed |
| Patient.extension[0].extension[1].url[0] | systemEffectiveDate |
| Patient.extension[0].extension[1].valueDateTime[0] | 2019-08-01T00:00:00.000Z |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-DeathNotificationStatus-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus"> <extension url="deathNotificationStatus"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus" /> <code value="U" /> <display value="Removed" /> </coding> </valueCodeableConcept> </extension> <extension url="systemEffectiveDate"> <valueDateTime value="2019-08-01T00:00:00.000Z" /> </extension> </extension> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-DeathNotificationStatus-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus", "extension": [ { "url": "deathNotificationStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus", "code": "U", "display": "Removed" } ] } }, { "url": "systemEffectiveDate", "valueDateTime": "2019-08-01T00:00:00.000Z" } ] } ] }
Example to illustrate the extension for the patients contact ranking
This example shows the extension which uses a PositiveInt to indicate the order that the people listed as contacts for the patient should be contacted. This example use the value 1 to show that this is the first person who should be conatacted.
Table View
| Patient.id[0] | UKCore-Patient-Extension-ContactRank-Example |
| Patient.contact[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank |
| Patient.contact[0].extension[0].valuePositiveInt[0] | 1 |
| Patient.contact[0].name[0].use[0] | official |
| Patient.contact[0].name[0].family[0] | CARTER |
| Patient.contact[0].name[0].given[0] | Emily |
| Patient.contact[0].telecom[0].system[0] | phone |
| Patient.contact[0].telecom[0].value[0] | 01131231288 |
| Patient.contact[0].gender[0] | female |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-ContactRank-Example" /> <contact> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"> <valuePositiveInt value="1" /> </extension> <!-- **************extension end************** --> <name> <use value="official" /> <family value="CARTER" /> <given value="Emily" /> </name> <telecom> <system value="phone" /> <value value="01131231288" /> </telecom> <gender value="female" /> </contact> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-ContactRank-Example", "contact": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank", "valuePositiveInt": 1 } ], "name": { "use": "official", "family": "CARTER", "given": [ "Emily" ] }, "telecom": [ { "system": "phone", "value": "01131231288" } ], "gender": "female" } ] }
An Example to illustrate the extension for copy correspondence indicators
This shows the extension that uses a Boolean value of true to indicate that the person named should be sent a copy of the correspondence.
Table View
| Patient.id[0] | UKCore-Patient-Extension-CopyCorrespondenceIndicator-Example |
| Patient.contact[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
| Patient.contact[0].extension[0].valueBoolean[0] | True |
| Patient.contact[0].name[0].use[0] | official |
| Patient.contact[0].name[0].family[0] | CARTER |
| Patient.contact[0].name[0].given[0] | Emily |
| Patient.contact[0].telecom[0].system[0] | phone |
| Patient.contact[0].telecom[0].value[0] | 01131231288 |
| Patient.contact[0].gender[0] | female |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-CopyCorrespondenceIndicator-Example" /> <contact> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator"> <valueBoolean value="true" /> </extension> <!-- **************extension end************** --> <name> <use value="official" /> <family value="CARTER" /> <given value="Emily" /> </name> <telecom> <system value="phone" /> <value value="01131231288" /> </telecom> <gender value="female" /> </contact> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-CopyCorrespondenceIndicator-Example", "contact": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator", "valueBoolean": true } ], "name": { "use": "official", "family": "CARTER", "given": [ "Emily" ] }, "telecom": [ { "system": "phone", "value": "01131231288" } ], "gender": "female" } ] }
An example to illustrate the extension for a patients birth sex
This example uses an extension to show the patients birth sex.
Table View
| Patient.id[0] | UKCore-Patient-Extension-BirthSex-Example |
| Patient.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex |
| Patient.extension[0].valueCode[0] | F |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-BirthSex-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex"> <valueCode value="F" /> </extension> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-BirthSex-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex", "valueCode": "F" } ] }
An example to illustrate the extension which shows the ethnic category for a patient
Table View
| Patient.id[0] | UKCore-Patient-Extension-EthnicCategory-Example |
| Patient.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory |
| Patient.extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategory |
| Patient.extension[0].valueCodeableConcept[0].coding[0].code[0] | A |
| Patient.extension[0].valueCodeableConcept[0].coding[0].display[0] | British, Mixed British |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-EthnicCategory-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategory" /> <code value="A" /> <display value="British, Mixed British" /> </coding> </valueCodeableConcept> </extension> <!-- *************extension end ***************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-EthnicCategory-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategory", "code": "A", "display": "British, Mixed British" } ] } } ] }
An example to illustrate the extension to indicate other contact system for a patient Richard Smith
Table View
| Patient.id[0] | UKCore-Patient-Extension-OtherContactSystem-Example |
| Patient.telecom[0].system[0] | other |
| Patient.telecom[0].system[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem |
| Patient.telecom[0].system[0].extension[0].valueCoding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem |
| Patient.telecom[0].system[0].extension[0].valueCoding[0].code[0] | textphone |
| Patient.telecom[0].system[0].extension[0].valueCoding[0].display[0] | Minicom (Textphone) |
| Patient.telecom[0].value[0] | +4413513341777 |
| Patient.telecom[0].use[0] | home |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-OtherContactSystem-Example" /> <telecom> <system value="other"> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem"> <valueCoding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem" /> <code value="textphone" /> <display value="Minicom (Textphone)" /> </valueCoding> </extension> <!-- *************extension end ***************** --> </system> <value value="+4413513341777" /> <use value="home" /> </telecom> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-OtherContactSystem-Example", "telecom": [ { "system": "other", "_system": { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem", "valueCoding": { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem", "code": "textphone", "display": "Minicom (Textphone)" } } ] }, "value": "+4413513341777", "use": "home" } ] }
An example of the extension which states the patient's NHS number verification status
Table View
| Patient.id[0] | UKCore-Patient-Extension-NHSNumberVerificationStatus-Example |
| Patient.identifier[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus |
| Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus |
| Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].code[0] | number-present-and-verified |
| Patient.identifier[0].extension[0].valueCodeableConcept[0].coding[0].display[0] | Number present and verified |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-NHSNumberVerificationStatus-Example" /> <identifier> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" /> <code value="number-present-and-verified" /> <display value="Number present and verified" /> </coding> </valueCodeableConcept> </extension> <!-- **************extension end************** --> </identifier> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-NHSNumberVerificationStatus-Example", "identifier": [ { "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus", "code": "number-present-and-verified", "display": "Number present and verified" } ] } } ] } ] }
An example to illustrate the extension to show the patient's residential status
Table View
| Patient.id[0] | UKCore-Patient-Extension-ResidentialStatus-Example |
| Patient.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus |
| Patient.extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus |
| Patient.extension[0].valueCodeableConcept[0].coding[0].code[0] | H |
| Patient.extension[0].valueCodeableConcept[0].coding[0].display[0] | UK Resident |
XML View
<Patient xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Extension-ResidentialStatus-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus" /> <code value="H" /> <display value="UK Resident" /> </coding> </valueCodeableConcept> </extension> <!-- **************extension end************** --> </Patient>
JSON View
{ "resourceType": "Patient", "id": "UKCore-Patient-Extension-ResidentialStatus-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-ResidentialStatus", "code": "H", "display": "UK Resident" } ] } } ] }
An example to illustrate a practitioner who is a Pharmacist
Table View
| Practitioner.id[0] | UKCore-Practitioner-PharmacistJimmyChuck-Example |
| Practitioner.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner |
| Practitioner.identifier[0].system[0] | https://fhir.nhs.uk/Id/sds-user-id |
| Practitioner.identifier[0].value[0] | P12345678 |
| Practitioner.name[0].family[0] | Chuck |
| Practitioner.name[0].given[0] | Jimmy |
| Practitioner.name[0].prefix[0] | Mr |
| Practitioner.telecom[0].system[0] | phone |
| Practitioner.telecom[0].value[0] | 0113 6323222 |
| Practitioner.telecom[0].use[0] | work |
| Practitioner.address[0].line[0] | INHOUSE PHARMACY |
| Practitioner.address[0].line[1] | ST. JAMES'S UNIVERSITY HOSPITAL |
| Practitioner.address[0].line[2] | BECKETT STREET |
| Practitioner.address[0].city[0] | LEEDS |
| Practitioner.address[0].postalCode[0] | LS9 7TF |
| Practitioner.address[0].country[0] | ENGLAND |
XML View
<Practitioner xmlns="http://hl7.org/fhir"> <id value="UKCore-Practitioner-PharmacistJimmyChuck-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" /> </meta> <identifier> <system value="https://fhir.nhs.uk/Id/sds-user-id" /> <value value="P12345678" /> </identifier> <name> <family value="Chuck" /> <given value="Jimmy" /> <prefix value="Mr" /> </name> <telecom> <system value="phone" /> <value value="0113 6323222" /> <use value="work" /> </telecom> <address> <line value="INHOUSE PHARMACY" /> <line value="ST. JAMES'S UNIVERSITY HOSPITAL" /> <line value="BECKETT STREET" /> <city value="LEEDS" /> <postalCode value="LS9 7TF" /> <country value="ENGLAND" /> </address> </Practitioner>
JSON View
{ "resourceType": "Practitioner", "id": "UKCore-Practitioner-PharmacistJimmyChuck-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" ] }, "identifier": [ { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "P12345678" } ], "name": [ { "family": "Chuck", "given": [ "Jimmy" ], "prefix": [ "Mr" ] } ], "telecom": [ { "system": "phone", "value": "0113 6323222", "use": "work" } ], "address": [ { "line": [ "INHOUSE PHARMACY", "ST. JAMES'S UNIVERSITY HOSPITAL", "BECKETT STREET" ], "city": "LEEDS", "postalCode": "LS9 7TF", "country": "ENGLAND" } ] }
An example to illustrate a practitioner who is a General Practitioner
Table View
| Practitioner.id[0] | UKCore-Practitioner-DoctorPaulRastall-Example |
| Practitioner.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner |
| Practitioner.identifier[0].system[0] | https://fhir.nhs.uk/Id/sds-user-id |
| Practitioner.identifier[0].value[0] | G12345678 |
| Practitioner.name[0].family[0] | Rastall |
| Practitioner.name[0].given[0] | Paul |
| Practitioner.name[0].prefix[0] | Dr |
| Practitioner.telecom[0].system[0] | phone |
| Practitioner.telecom[0].value[0] | 0113 6323200 |
| Practitioner.telecom[0].use[0] | work |
| Practitioner.address[0].use[0] | work |
| Practitioner.address[0].type[0] | both |
| Practitioner.address[0].line[0] | Chapel Main Practice |
| Practitioner.address[0].line[1] | 22 Brightside Crescent |
| Practitioner.address[0].city[0] | Overtown |
| Practitioner.address[0].district[0] | West Yorkshire |
| Practitioner.address[0].postalCode[0] | LS10 4YU |
| Practitioner.gender[0] | male |
XML View
<Practitioner xmlns="http://hl7.org/fhir"> <id value="UKCore-Practitioner-DoctorPaulRastall-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" /> </meta> <identifier> <system value="https://fhir.nhs.uk/Id/sds-user-id" /> <value value="G12345678" /> </identifier> <name> <family value="Rastall" /> <given value="Paul" /> <prefix value="Dr" /> </name> <telecom> <system value="phone" /> <value value="0113 6323200" /> <use value="work" /> </telecom> <address> <use value="work" /> <type value="both" /> <line value="Chapel Main Practice" /> <line value="22 Brightside Crescent" /> <city value="Overtown" /> <district value="West Yorkshire" /> <postalCode value="LS10 4YU" /> </address> <gender value="male" /> </Practitioner>
JSON View
{ "resourceType": "Practitioner", "id": "UKCore-Practitioner-DoctorPaulRastall-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" ] }, "identifier": [ { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "G12345678" } ], "name": [ { "family": "Rastall", "given": [ "Paul" ], "prefix": [ "Dr" ] } ], "telecom": [ { "system": "phone", "value": "0113 6323200", "use": "work" } ], "address": [ { "use": "work", "type": "both", "line": [ "Chapel Main Practice", "22 Brightside Crescent" ], "city": "Overtown", "district": "West Yorkshire", "postalCode": "LS10 4YU" } ], "gender": "male" }
An example to illustrate a practitioner who is a consultant
Table View
| Practitioner.id[0] | UKCore-Practitioner-ConsultantSandraGose-Example |
| Practitioner.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner |
| Practitioner.identifier[0].system[0] | https://fhir.nhs.uk/Id/sds-user-id |
| Practitioner.identifier[0].value[0] | C12345678 |
| Practitioner.name[0].family[0] | Gose |
| Practitioner.name[0].given[0] | Sandra |
| Practitioner.name[0].prefix[0] | Mrs |
| Practitioner.telecom[0].system[0] | phone |
| Practitioner.telecom[0].value[0] | 0113 6323211 |
| Practitioner.telecom[0].use[0] | work |
| Practitioner.address[0].line[0] | Admissions Department |
| Practitioner.address[0].line[1] | ST. JAMES'S UNIVERSITY HOSPITAL |
| Practitioner.address[0].line[2] | BECKETT STREET |
| Practitioner.address[0].city[0] | LEEDS |
| Practitioner.address[0].postalCode[0] | LS9 7TF |
| Practitioner.address[0].country[0] | ENGLAND |
| Practitioner.gender[0] | female |
XML View
<Practitioner xmlns="http://hl7.org/fhir"> <id value="UKCore-Practitioner-ConsultantSandraGose-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" /> </meta> <identifier> <system value="https://fhir.nhs.uk/Id/sds-user-id" /> <value value="C12345678" /> </identifier> <name> <family value="Gose" /> <given value="Sandra" /> <prefix value="Mrs" /> </name> <telecom> <system value="phone" /> <value value="0113 6323211" /> <use value="work" /> </telecom> <address> <line value="Admissions Department" /> <line value="ST. JAMES'S UNIVERSITY HOSPITAL" /> <line value="BECKETT STREET" /> <city value="LEEDS" /> <postalCode value="LS9 7TF" /> <country value="ENGLAND" /> </address> <gender value="female" /> </Practitioner>
JSON View
{ "resourceType": "Practitioner", "id": "UKCore-Practitioner-ConsultantSandraGose-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" ] }, "identifier": [ { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "C12345678" } ], "name": [ { "family": "Gose", "given": [ "Sandra" ], "prefix": [ "Mrs" ] } ], "telecom": [ { "system": "phone", "value": "0113 6323211", "use": "work" } ], "address": [ { "line": [ "Admissions Department", "ST. JAMES'S UNIVERSITY HOSPITAL", "BECKETT STREET" ], "city": "LEEDS", "postalCode": "LS9 7TF", "country": "ENGLAND" } ], "gender": "female" }
An example to illustrate a practitioner role of general practitioner
Table View
| PractitionerRole.id[0] | UKCore-PractitionerRole-GeneralPractitioner-Example |
| PractitionerRole.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole |
| PractitionerRole.identifier[0].system[0] | https://fhir.nhs.uk/Id/sds-role-profile-id |
| PractitionerRole.identifier[0].value[0] | 100334993514 |
| PractitionerRole.practitioner[0].reference[0] | Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example |
| PractitionerRole.organization[0].reference[0] | Organization/UKCore-Organisation-WhiteRoseMedicalCentre-Example |
| PractitionerRole.code[0].coding[0].system[0] | http://snomed.info/sct |
| PractitionerRole.code[0].coding[0].code[0] | 62247001 |
| PractitionerRole.code[0].coding[0].display[0] | General practitioner |
| PractitionerRole.specialty[0].coding[0].system[0] | http://snomed.info/sct |
| PractitionerRole.specialty[0].coding[0].code[0] | 408443003 |
| PractitionerRole.specialty[0].coding[0].display[0] | General medical practice |
| PractitionerRole.telecom[0].system[0] | phone |
| PractitionerRole.telecom[0].value[0] | 0113 6323200 |
| PractitionerRole.telecom[0].use[0] | work |
XML View
<PractitionerRole xmlns="http://hl7.org/fhir"> <id value="UKCore-PractitionerRole-GeneralPractitioner-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" /> </meta> <identifier> <system value="https://fhir.nhs.uk/Id/sds-role-profile-id" /> <value value="100334993514" /> </identifier> <practitioner> <reference value="Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" /> </practitioner> <organization> <reference value="Organization/UKCore-Organisation-WhiteRoseMedicalCentre-Example" /> </organization> <code> <coding> <system value="http://snomed.info/sct" /> <code value="62247001" /> <display value="General practitioner" /> </coding> </code> <specialty> <coding> <system value="http://snomed.info/sct" /> <code value="408443003" /> <display value="General medical practice" /> </coding> </specialty> <telecom> <system value="phone" /> <value value="0113 6323200" /> <use value="work" /> </telecom> </PractitionerRole>
JSON View
{ "resourceType": "PractitionerRole", "id": "UKCore-PractitionerRole-GeneralPractitioner-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" ] }, "identifier": [ { "system": "https://fhir.nhs.uk/Id/sds-role-profile-id", "value": "100334993514" } ], "practitioner": { "reference": "Practitioner/UKCore-Practitioner-DoctorPaulRastall-Example" }, "organization": { "reference": "Organization/UKCore-Organisation-WhiteRoseMedicalCentre-Example" }, "code": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "62247001", "display": "General practitioner" } ] } ], "specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "408443003", "display": "General medical practice" } ] } ], "telecom": [ { "system": "phone", "value": "0113 6323200", "use": "work" } ] }
An example to illustrate a procedure of skin examination
Table View
| Procedure.id[0] | UKCore-Procedure-ExaminationOfSkin-Example |
| Procedure.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure |
| Procedure.status[0] | completed |
| Procedure.code[0].coding[0].system[0] | http://snomed.info/sct |
| Procedure.code[0].coding[0].code[0] | 128004 |
| Procedure.code[0].coding[0].display[0] | Hand microscope examination of skin |
| Procedure.subject[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| Procedure.performedDateTime[0] | 2019-12-10T13:00:00+00:00 |
XML View
<Procedure xmlns="http://hl7.org/fhir"> <id value="UKCore-Procedure-ExaminationOfSkin-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure" /> </meta> <status value="completed" /> <code> <coding> <system value="http://snomed.info/sct" /> <code value="128004" /> <display value="Hand microscope examination of skin" /> </coding> </code> <subject> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </subject> <performedDateTime value="2019-12-10T13:00:00+00:00" /> </Procedure>
JSON View
{ "resourceType": "Procedure", "id": "UKCore-Procedure-ExaminationOfSkin-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure" ] }, "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "128004", "display": "Hand microscope examination of skin" } ] }, "subject": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "performedDateTime": "2019-12-10T13:00:00+00:00" }
An example to illustrate a person who is Related to the patient
UKCore-RelatedPerson-JoySmith-Example
Table View
| RelatedPerson.id[0] | UKCore-RelatedPerson-JoySmith-Example |
| RelatedPerson.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson |
| RelatedPerson.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
| RelatedPerson.extension[0].extension[0].url[0] | PreferredContactMethod |
| RelatedPerson.extension[0].extension[0].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod |
| RelatedPerson.extension[0].extension[0].valueCodeableConcept[0].coding[0].code[0] | 3 |
| RelatedPerson.extension[0].extension[0].valueCodeableConcept[0].coding[0].display[0] | Telephone |
| RelatedPerson.extension[0].extension[1].url[0] | PreferredContactTimes |
| RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].frequency[0] | 1 |
| RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].period[0] | 1 |
| RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].periodUnit[0] | d |
| RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[0] | mon |
| RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[1] | wed |
| RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].dayOfWeek[2] | fri |
| RelatedPerson.extension[0].extension[1].valueTiming[0].repeat[0].when[0] | AFT |
| RelatedPerson.extension[0].extension[2].url[0] | PreferredWrittenCommunicationFormat |
| RelatedPerson.extension[0].extension[2].valueCodeableConcept[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat |
| RelatedPerson.extension[0].extension[2].valueCodeableConcept[0].coding[0].code[0] | 11 |
| RelatedPerson.extension[0].extension[2].valueCodeableConcept[0].coding[0].display[0] | Large print |
| RelatedPerson.extension[1].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank |
| RelatedPerson.extension[1].valuePositiveInt[0] | 1 |
| RelatedPerson.extension[2].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
| RelatedPerson.extension[2].valueBoolean[0] | True |
| RelatedPerson.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| RelatedPerson.relationship[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/v3-RoleCode |
| RelatedPerson.relationship[0].coding[0].code[0] | WIFE |
| RelatedPerson.relationship[0].coding[0].display[0] | wife |
| RelatedPerson.name[0].use[0] | official |
| RelatedPerson.name[0].family[0] | SMITH |
| RelatedPerson.name[0].given[0] | Joy |
XML View
<RelatedPerson xmlns="http://hl7.org/fhir"> <id value="UKCore-RelatedPerson-JoySmith-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" /> </meta> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"> <extension url="PreferredContactMethod"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod" /> <code value="3" /> <display value="Telephone" /> </coding> </valueCodeableConcept> </extension> <extension url="PreferredContactTimes"> <valueTiming> <repeat> <frequency value="1" /> <period value="1" /> <periodUnit value="d" /> <dayOfWeek value="mon" /> <dayOfWeek value="wed" /> <dayOfWeek value="fri" /> <when value="AFT" /> </repeat> </valueTiming> </extension> <extension url="PreferredWrittenCommunicationFormat"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat" /> <code value="11" /> <display value="Large print" /> </coding> </valueCodeableConcept> </extension> </extension> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"> <valuePositiveInt value="1" /> </extension> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator"> <valueBoolean value="true" /> </extension> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <relationship> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" /> <code value="WIFE" /> <display value="wife" /> </coding> </relationship> <name> <use value="official" /> <family value="SMITH" /> <given value="Joy" /> </name> </RelatedPerson>
JSON View
{ "resourceType": "RelatedPerson", "id": "UKCore-RelatedPerson-JoySmith-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" ] }, "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference", "extension": [ { "url": "PreferredContactMethod", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod", "code": "3", "display": "Telephone" } ] } }, { "url": "PreferredContactTimes", "valueTiming": { "repeat": { "frequency": 1, "period": 1, "periodUnit": "d", "dayOfWeek": [ "mon", "wed", "fri" ], "when": [ "AFT" ] } } }, { "url": "PreferredWrittenCommunicationFormat", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat", "code": "11", "display": "Large print" } ] } } ] }, { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank", "valuePositiveInt": 1 }, { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator", "valueBoolean": true } ], "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "relationship": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE", "display": "wife" } ] } ], "name": [ { "use": "official", "family": "SMITH", "given": [ "Joy" ] } ] }
An example to illustrate the extension for a vaccination procedure for COVID
Table View
| Immunization.id[0] | UKCore-Immunization-Extension-ParentPresent-Example |
| Immunization.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent |
| Immunization.extension[0].valueBoolean[0] | True |
| Immunization.status[0] | completed |
| Immunization.vaccineCode[0].coding[0].system[0] | https://dmd.nhs.uk |
| Immunization.vaccineCode[0].coding[0].code[0] | 10245211000001108 |
| Immunization.vaccineCode[0].coding[0].display[0] | Pneumococcal polysaccharide conjugated vaccine (adsorbed) suspension for injection 0.5ml pre-filled syringes |
| Immunization.patient[0].reference[0] | Patient/UKCore-Patient-BabyPatient-Example |
| Immunization.occurrenceDateTime[0] | 2021-07-20 |
XML View
<Immunization xmlns="http://hl7.org/fhir"> <id value="UKCore-Immunization-Extension-ParentPresent-Example" /> <!-- **************extension start************** --> <!-- This describes whether a parent was present at the immunisation of a child. --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent"> <valueBoolean value="true" /> </extension> <!-- **************extension end************** --> <status value="completed" /> <vaccineCode> <coding> <system value="https://dmd.nhs.uk" /> <code value="10245211000001108" /> <display value="Pneumococcal polysaccharide conjugated vaccine (adsorbed) suspension for injection 0.5ml pre-filled syringes" /> </coding> </vaccineCode> <patient> <reference value="Patient/UKCore-Patient-BabyPatient-Example" /> </patient> <occurrenceDateTime value="2021-07-20" /> </Immunization>
JSON View
{ "resourceType": "Immunization", "id": "UKCore-Immunization-Extension-ParentPresent-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent", "valueBoolean": true } ], "status": "completed", "vaccineCode": { "coding": [ { "system": "https://dmd.nhs.uk", "code": "10245211000001108", "display": "Pneumococcal polysaccharide conjugated vaccine (adsorbed) suspension for injection 0.5ml pre-filled syringes" } ] }, "patient": { "reference": "Patient/UKCore-Patient-BabyPatient-Example" }, "occurrenceDateTime": "2021-07-20" }
An example to illustrate the extension for a vaccination procedure
Table View
| Immunization.id[0] | UKCore-Immunization-Extension-VaccinationProcedure-Example |
| Immunization.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure |
| Immunization.extension[0].valueCodeableConcept[0].coding[0].system[0] | http://snomed.info/sct |
| Immunization.extension[0].valueCodeableConcept[0].coding[0].code[0] | 73701000119109 |
| Immunization.extension[0].valueCodeableConcept[0].coding[0].display[0] | Influenza vaccination given |
| Immunization.status[0] | completed |
| Immunization.vaccineCode[0].coding[0].system[0] | https://dmd.nhs.uk |
| Immunization.vaccineCode[0].coding[0].code[0] | 11278411000001109 |
| Immunization.vaccineCode[0].coding[0].display[0] | Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd) |
| Immunization.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| Immunization.occurrenceDateTime[0] | 2013-01-10 |
XML View
<Immunization xmlns="http://hl7.org/fhir"> <id value="UKCore-Immunization-Extension-VaccinationProcedure-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure"> <valueCodeableConcept> <coding> <system value="http://snomed.info/sct" /> <code value="73701000119109" /> <display value="Influenza vaccination given" /> </coding> </valueCodeableConcept> </extension> <!-- **************extension end************** --> <status value="completed" /> <vaccineCode> <coding> <system value="https://dmd.nhs.uk" /> <code value="11278411000001109" /> <display value="Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)" /> </coding> </vaccineCode> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <occurrenceDateTime value="2013-01-10" /> </Immunization>
JSON View
{ "resourceType": "Immunization", "id": "UKCore-Immunization-Extension-VaccinationProcedure-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure", "valueCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "73701000119109", "display": "Influenza vaccination given" } ] } } ], "status": "completed", "vaccineCode": { "coding": [ { "system": "https://dmd.nhs.uk", "code": "11278411000001109", "display": "Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)" } ] }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "occurrenceDateTime": "2013-01-10" }
An example to illustrate the extension for a vaccination procedure for COVID
Table View
| Immunization.id[0] | UKCore-Immunization-Extension-VaccinationProcedure-COVID-Example |
| Immunization.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure |
| Immunization.extension[0].valueCodeableConcept[0].coding[0].system[0] | http://snomed.info/sct |
| Immunization.extension[0].valueCodeableConcept[0].coding[0].code[0] | 1324681000000101 |
| Immunization.extension[0].valueCodeableConcept[0].coding[0].display[0] | Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure) |
| Immunization.status[0] | completed |
| Immunization.vaccineCode[0].coding[0].system[0] | https://dmd.nhs.uk |
| Immunization.vaccineCode[0].coding[0].code[0] | 39116211000001106 |
| Immunization.vaccineCode[0].coding[0].display[0] | Generic COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials |
| Immunization.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| Immunization.occurrenceDateTime[0] | 2021-07-20 |
XML View
<Immunization xmlns="http://hl7.org/fhir"> <id value="UKCore-Immunization-Extension-VaccinationProcedure-COVID-Example" /> <!-- **************extension start************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure"> <valueCodeableConcept> <coding> <system value="http://snomed.info/sct" /> <code value="1324681000000101" /> <display value="Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" /> </coding> </valueCodeableConcept> </extension> <!-- **************extension end************** --> <status value="completed" /> <vaccineCode> <coding> <system value="https://dmd.nhs.uk" /> <code value="39116211000001106" /> <display value="Generic COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials" /> </coding> </vaccineCode> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <occurrenceDateTime value="2021-07-20" /> </Immunization>
JSON View
{ "resourceType": "Immunization", "id": "UKCore-Immunization-Extension-VaccinationProcedure-COVID-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure", "valueCodeableConcept": { "coding": [ { "system": "http://snomed.info/sct", "code": "1324681000000101", "display": "Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" } ] } } ], "status": "completed", "vaccineCode": { "coding": [ { "system": "https://dmd.nhs.uk", "code": "39116211000001106", "display": "Generic COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials" } ] }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "occurrenceDateTime": "2021-07-20" }
An example to illustrate an vaccination for Flu
Table View
| Immunization.id[0] | UKCore-Immunization-InfluenzaVaccine-Example |
| Immunization.meta[0].profile[0] | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization |
| Immunization.status[0] | completed |
| Immunization.vaccineCode[0].coding[0].system[0] | https://dmd.nhs.uk |
| Immunization.vaccineCode[0].coding[0].code[0] | 11278411000001109 |
| Immunization.vaccineCode[0].coding[0].display[0] | Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd) |
| Immunization.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
| Immunization.occurrenceDateTime[0] | 2013-01-10 |
| Immunization.location[0].reference[0] | UKCore-Location-GeneralPracticeNurseClinic-Example |
XML View
<Immunization xmlns="http://hl7.org/fhir"> <id value="UKCore-Immunization-InfluenzaVaccine-Example" /> <meta> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization" /> </meta> <status value="completed" /> <vaccineCode> <coding> <system value="https://dmd.nhs.uk" /> <code value="11278411000001109" /> <display value="Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)" /> </coding> </vaccineCode> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <occurrenceDateTime value="2013-01-10" /> <location> <reference value="UKCore-Location-GeneralPracticeNurseClinic-Example" /> </location> </Immunization>
JSON View
{ "resourceType": "Immunization", "id": "UKCore-Immunization-InfluenzaVaccine-Example", "meta": { "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization" ] }, "status": "completed", "vaccineCode": { "coding": [ { "system": "https://dmd.nhs.uk", "code": "11278411000001109", "display": "Influenza vaccine (split virion, inactivated) suspension for injection 0.5ml pre-filled syringes (Pfizer Ltd)" } ] }, "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "occurrenceDateTime": "2013-01-10", "location": { "reference": "UKCore-Location-GeneralPracticeNurseClinic-Example" } }
Example to illustrate the date range that this organization should be considered available using the common extension
Table View
| Organization.id[0] | Organization-Extension-Period-Example |
| Organization.extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/organization-period |
| Organization.extension[0].valuePeriod[0].start[0] | 2017-01-01T00:00:00.000Z |
| Organization.identifier[0].use[0] | official |
| Organization.identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
| Organization.identifier[0].value[0] | RR8 |
| Organization.name[0] | LEEDS TEACHING HOSPITALS NHS TRUST |
XML View
<Organization xmlns="http://hl7.org/fhir"> <id value="Organization-Extension-Period-Example" /> <!-- **************extension start************** --> <extension url="http://hl7.org/fhir/StructureDefinition/organization-period"> <valuePeriod> <start value="2017-01-01T00:00:00.000Z" /> </valuePeriod> </extension> <!-- *************extension end ***************** --> <identifier> <use value="official" /> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="RR8" /> </identifier> <name value="LEEDS TEACHING HOSPITALS NHS TRUST" /> </Organization>
JSON View
{ "resourceType": "Organization", "id": "Organization-Extension-Period-Example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/organization-period", "valuePeriod": { "start": "2017-01-01T00:00:00.000Z" } } ], "identifier": [ { "use": "official", "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RR8" } ], "name": "LEEDS TEACHING HOSPITALS NHS TRUST" }