Release
4
5
Administration
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0:
R5
-
Mixed
Normative
and
STU
)
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
| Patient Administration Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Encounter , Patient , Practitioner , RelatedPerson |
Raw JSON ( canonical form + also see JSON Format Specification )
Real-world encounter example (with primaryDiagnosis extension added)
{
"resourceType": "Encounter",
"id": "f202",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: f202</p><p><b>identifier</b>: Encounter_Roel_20130128 (TEMP)</p><p><b>status</b>: finished</p><p><b>class</b>: ambulatory (Details: http://terminology.hl7.org/CodeSystem/v3-ActCode code AMB = 'ambulatory', stated as 'ambulatory')</p><p><b>type</b>: Chemotherapy <span>(Details : {SNOMED CT code '367336001' = 'Chemotherapy', given as 'Chemotherapy'})</span></p><p><b>priority</b>: Urgent <span>(Details : {SNOMED CT code '103391001' = 'Urgency', given as 'Urgent'})</span></p><p><b>subject</b>: <a>Roel</a></p><h3>Participants</h3><table><tr><td>-</td><td><b>Individual</b></td></tr><tr><td>*</td><td><a>Practitioner/f201</a></td></tr></table><p><b>length</b>: 56 minutes<span> (Details: UCUM code min = 'min')</span></p><p><b>reasonCode</b>: The patient is treated for a tumor. <span>(Details )</span></p><blockquote><p><b>diagnosis</b></p><p><b>condition</b>: Complications from Roel's TPF chemotherapy on January 28th, 2013</p><p><b>use</b>: Admission diagnosis <span>(Details : {http://terminology.hl7.org/CodeSystem/diagnosis-role code 'AD' = 'Admission diagnosis', given as 'Admission diagnosis'})</span></p><p><b>rank</b>: 2</p></blockquote><blockquote><p><b>diagnosis</b></p><p><b>condition</b>: The patient is treated for a tumor</p><p><b>use</b>: Chief complaint <span>(Details : {http://terminology.hl7.org/CodeSystem/diagnosis-role code 'CC' = 'Chief complaint', given as 'Chief complaint'})</span></p><p><b>rank</b>: 1</p></blockquote><p><b>serviceProvider</b>: <a>Organization/f201</a></p></div>"
"resourceType" : "Encounter",
"id" : "f202",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: Encounter</b><a name=\"f202\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource Encounter "f202" </p></div><p><b>identifier</b>: id:\u00a0Encounter_Roel_20130128\u00a0(use:\u00a0TEMP)</p><p><b>status</b>: completed</p><p><b>class</b>: <span title=\" Encounter has finished \">ambulatory <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ActCode.html\">ActCode</a>#AMB)</span></span></p><p><b>priority</b>: Urgent <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#103391001)</span></p><p><b>type</b>: Chemotherapy <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#367336001)</span></p><p><b>subject</b>: <a href=\"patient-example-f201-roel.html\">Patient/f201: Roel</a> "Roel"</p><p><b>serviceProvider</b>: <a href=\"organization-example-f201-aumc.html\">Organization/f201</a> "Artis University Medical Center (AUMC)"</p><h3>Participants</h3><table class=\"grid\"><tr><td>-</td><td><b>Actor</b></td></tr><tr><td>*</td><td><a href=\"practitioner-example-f201-ab.html\">Practitioner/f201</a> "Dokter Bronsig"</td></tr></table><h3>Lengths</h3><table class=\"grid\"><tr><td>-</td><td><b>Value</b></td><td><b>Unit</b></td><td><b>System</b></td><td><b>Code</b></td></tr><tr><td>*</td><td>56</td><td>minutes</td><td><a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ucum.html\">Unified Code for Units of Measure (UCUM)</a></td><td>min</td></tr></table><blockquote><p><b>reason</b></p><h3>Values</h3><table class=\"grid\"><tr><td>-</td><td><b>Concept</b></td></tr><tr><td>*</td><td>The patient is treated for a tumor. <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></td></tr></table></blockquote><blockquote><p><b>diagnosis</b></p><h3>Conditions</h3><table class=\"grid\"><tr><td>-</td><td><b>Concept</b></td></tr><tr><td>*</td><td>Complications from Roel's TPF chemotherapy on January 28th, 2013 <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></td></tr></table><p><b>use</b>: Admission diagnosis <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-diagnosis-role.html\">Diagnosis Role</a>#AD)</span></p></blockquote><blockquote><p><b>diagnosis</b></p><h3>Conditions</h3><table class=\"grid\"><tr><td>-</td><td><b>Concept</b></td></tr><tr><td>*</td><td>The patient is treated for a tumor <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></td></tr></table><p><b>use</b>: Chief complaint <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-diagnosis-role.html\">Diagnosis Role</a>#CC)</span></p></blockquote></div>"
},
"identifier": [
{
"use": "temp",
"value": "Encounter_Roel_20130128"
}
],
"status": "finished",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "AMB",
"display": "ambulatory"
"identifier" : [{
"use" : "temp",
"value" : "Encounter_Roel_20130128"
}],
"status" : "completed",
"class" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "AMB",
"display" : "ambulatory"
}]
}],
"priority" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "103391001",
"display" : "Urgent"
}]
},
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "367336001",
"display": "Chemotherapy"
}
]
}
],
"priority": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "103391001",
"display": "Urgent"
}
]
"type" : [{
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "367336001",
"display" : "Chemotherapy"
}]
}],
"subject" : {
"reference" : "Patient/f201",
"display" : "Roel"
},
"subject": {
"reference": "Patient/f201",
"display": "Roel"
"serviceProvider" : {
"reference" : "Organization/f201"
},
"participant": [
{
"individual": {
"reference": "Practitioner/f201"
}
"participant" : [{
"actor" : {
"reference" : "Practitioner/f201"
}
],
"length": {
"value": 56,
"unit": "minutes",
"system": "http://unitsofmeasure.org",
"code": "min"
}],
"length" : {
"value" : 56,
"unit" : "minutes",
"system" : "http://unitsofmeasure.org",
"code" : "min"
},
"reasonCode": [
{
"text": "The patient is treated for a tumor."
}
],
"diagnosis": [
{
"condition": {
"display": "Complications from Roel's TPF chemotherapy on January 28th, 2013"
},
"use": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code": "AD",
"display": "Admission diagnosis"
}
]
},
"rank": 2
},
{
"condition": {
"display": "The patient is treated for a tumor"
},
"use": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code": "CC",
"display": "Chief complaint"
}
]
},
"rank": 1
}
],
"serviceProvider": {
"reference": "Organization/f201"
}
"reason" : [{
"value" : [{
"concept" : {
"text" : "The patient is treated for a tumor."
}
}]
}],
"diagnosis" : [{
"condition" : [{
"concept" : {
"text" : "Complications from Roel's TPF chemotherapy on January 28th, 2013"
}
}],
"use" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code" : "AD",
"display" : "Admission diagnosis"
}]
}]
},
{
"condition" : [{
"concept" : {
"text" : "The patient is treated for a tumor"
}
}],
"use" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/diagnosis-role",
"code" : "CC",
"display" : "Chief complaint"
}]
}]
}]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R5
hl7.fhir.core#5.0.0
generated
on
Fri,
Nov
1,
2019
09:35+1100.
QA
Page
Sun,
Mar
26,
2023
15:24+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R4B
|
|
Propose
a
change