Release 5 Ballot
DiagnosticsThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
Raw JSON (canonical form + also see JSON Format Specification)
XDS Comprehensive metadata
{
"resourceType": "DocumentReference",
"id": "example-comprehensive",
"meta": {
"security": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
"code": "HTEST"
}
]
},
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: DocumentReference</b><a name=\"example-comprehensive\"> </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 DocumentReference "example-comprehensive" </p><p style=\"margin-bottom: 0px\">Security Labels: <span title=\"{http://terminology.hl7.org/CodeSystem/v3-ActReason http://terminology.hl7.org/CodeSystem/v3-ActReason}\">http://terminology.hl7.org/CodeSystem/v3-ActReason</span></p></div><p><b>sourcepatient</b>: <a name=\"in-patient\"> </a></p><blockquote><p><b>Anonymous Patient</b> (no stated gender), DoB Unknown</p></blockquote><p><b>identifier</b>: id: urn:oid:1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340, id: urn:uuid:0c287d32-01e3-4d87-9953-9fcc9404eb21</p><p><b>status</b>: current</p><p><b>type</b>: Addendum Document <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://loinc.org/\">LOINC</a>#55107-7)</span></p><p><b>category</b>: History of immunization Narrative <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://loinc.org/\">LOINC</a>#11369-6)</span></p><p><b>subject</b>: <a href=\"patient-example-xcda.html\">Patient/xcda</a> "Henry LEVIN"</p><h3>Events</h3><table class=\"grid\"><tr><td>-</td><td><b>Concept</b></td><td><b>Reference</b></td></tr><tr><td>*</td><td>account receivable <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v3-ActCode.html\">ActCode</a>#ACCTRECEIVABLE)</span></td><td> </td></tr><tr><td>*</td><td> </td><td><span/></td></tr></table><p><b>facilityType</b>: Children's hospital <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#82242000)</span></p><p><b>practiceSetting</b>: Adult mental illness - speciality <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#408467006)</span></p><p><b>period</b>: 2020-12-31T23:50:50-05:00 --> 2020-12-31T23:50:50-05:00</p><p><b>date</b>: 01/01/2021 3:50:50 PM</p><p><b>author</b>: <a name=\"in-author\"> </a></p><blockquote><p/><p><a name=\"in-author\"> </a></p><p><b>telecom</b>: <a href=\"mailto:JohnMoehrke@gmail.com\">JohnMoehrke@gmail.com</a></p></blockquote><h3>Attesters</h3><table class=\"grid\"><tr><td>-</td><td><b>Mode</b></td><td><b>Party</b></td></tr><tr><td>*</td><td>Professional <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-composition-attestation-mode.html\">CompositionAttestationMode</a>#professional)</span></td><td><a name=\"in-author\"> </a><blockquote><p/><p><a name=\"in-author\"> </a></p><p><b>telecom</b>: <a href=\"mailto:JohnMoehrke@gmail.com\">JohnMoehrke@gmail.com</a></p></blockquote></td></tr></table><h3>RelatesTos</h3><table class=\"grid\"><tr><td>-</td><td><b>Code</b></td><td><b>Target</b></td></tr><tr><td>*</td><td>Appends <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-document-relationship-type.html\">DocumentRelationshipType</a>#appends)</span></td><td><a href=\"documentreference-example.html\">DocumentReference/example</a></td></tr></table><p><b>description</b>: Example of a Comprehensive DocumentReference resource. This is fully filled for all mandatory elements and all optional elements.</p><p><b>securityLabel</b>: normal <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v3-Confidentiality.html\">Confidentiality</a>#N)</span></p><blockquote><p><b>content</b></p><h3>Attachments</h3><table class=\"grid\"><tr><td>-</td><td><b>ContentType</b></td><td><b>Language</b></td><td><b>Url</b></td><td><b>Size</b></td><td><b>Hash</b></td><td><b>Title</b></td><td><b>Creation</b></td></tr><tr><td>*</td><td>text/plain</td><td>en</td><td><a href=\"http://example.com/nowhere.txt\">http://example.com/nowhere.txt</a></td><td>190</td><td>OGEzOGYyNjMzMDA2ZmQ1MzUxNDljNDRhM2E3M2YzMTI0MzdiMzQ3OA==</td><td>DocumentReference for Comprehensive fully filled metadata</td><td>2020-12-31T23:50:50-05:00</td></tr></table><h3>Profiles</h3><table class=\"grid\"><tr><td>-</td><td><b>Value[x]</b></td></tr><tr><td>*</td><td>ITI XDS-SD TEXT (Details: http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode code urn:ihe:iti:xds-sd:text:2008 = 'ITI XDS-SD TEXT', stated as 'null')</td></tr></table></blockquote></div>"
},
"contained": [
{
"resourceType": "Practitioner",
"id": "in-author",
"telecom": [
{
"system": "email",
"value": "JohnMoehrke@gmail.com"
}
]
},
{
"resourceType": "Patient",
"id": "in-patient"
}
],
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/documentreference-sourcepatient",
"valueReference": {
"reference": "#in-patient"
}
}
],
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340"
},
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:0c287d32-01e3-4d87-9953-9fcc9404eb21"
}
],
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "55107-7"
}
]
},
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "11369-6"
}
]
}
],
"subject": {
"reference": "Patient/xcda"
},
"event": [
{
"concept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "ACCTRECEIVABLE"
}
]
}
},
{
"reference": {
"identifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.2.840.113556.1.8000.2554.17917.46600.21181.17878.33419.62048.57128.2759"
}
}
}
],
"facilityType": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "82242000"
}
]
},
"practiceSetting": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "408467006"
}
]
},
"period": {
"start": "2020-12-31T23:50:50-05:00",
"end": "2020-12-31T23:50:50-05:00"
},
"date": "2020-12-31T23:50:50-05:00",
"author": [
{
"reference": "#in-author"
}
],
"attester": [
{
"mode": {
"coding": [
{
"system": "http://hl7.org/fhir/composition-attestation-mode",
"code": "professional"
}
]
},
"party": {
"reference": "#in-author"
}
}
],
"relatesTo": [
{
"code": {
"coding": [
{
"system": "http://hl7.org/fhir/document-relationship-type",
"code": "appends"
}
]
},
"target": {
"reference": "DocumentReference/example"
}
}
],
"description": "Example of a Comprehensive DocumentReference resource. This is fully filled for all mandatory elements and all optional elements.",
"securityLabel": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N"
}
]
}
],
"content": [
{
"attachment": {
"contentType": "text/plain",
"language": "en",
"url": "http://example.com/nowhere.txt",
"size": "190",
"hash": "OGEzOGYyNjMzMDA2ZmQ1MzUxNDljNDRhM2E3M2YzMTI0MzdiMzQ3OA==",
"title": "DocumentReference for Comprehensive fully filled metadata",
"creation": "2020-12-31T23:50:50-05:00"
},
"profile": [
{
"valueCoding": {
"system": "http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode",
"code": "urn:ihe:iti:xds-sd:text:2008"
}
}
]
}
]
}
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 R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:08+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change