Please note:
- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
An example to illustrate an inpatient encounter
Table View
Encounter.id[0] | UKCore-Encounter-InpatientEncounter-Example |
Encounter.text[0].status[0] | additional |
Encounter.text[0].div[0] | <div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate an inpatient encounter</div> |
Encounter.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod |
Encounter.extension[0].value[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeMethodEngland |
Encounter.extension[0].value[0].coding[0].code[0] | 1 |
Encounter.extension[0].value[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].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod |
Encounter.hospitalization[0].extension[0].value[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland |
Encounter.hospitalization[0].extension[0].value[0].coding[0].code[0] | 13 |
Encounter.hospitalization[0].extension[0].value[0].coding[0].display[0] | Elective Admission: Planned |
Encounter.hospitalization[0].dischargeDisposition[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeDestinationEngland |
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 |
Tree View
Encounter |
id : UKCore-Encounter-InpatientEncounter-Example |
text |
status : additional |
extension |
url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DischargeMethod |
value |
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 |
extension |
url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdmissionMethod |
value |
coding |
system : https://fhir.hl7.org.uk/CodeSystem/UKCore-AdmissionMethodEngland |
code : 13 |
display : Elective Admission: Planned |
dischargeDisposition |
coding |
system : https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeDestinationEngland |
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 |
XML View
<Encounter xmlns="http://hl7.org/fhir"> <id value="UKCore-Encounter-InpatientEncounter-Example" /> <text> <status value="additional" /> --- We have skipped the narrative for better readability of the resource --- </text> <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> <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> <dischargeDisposition> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeDestinationEngland" /> <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", "text": { "status": "additional", --- We have skipped the narrative for better readability of the resource --- }, "extension": [ { "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": { "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" } ] } } ], "dischargeDisposition": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DischargeDestinationEngland", "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" } }