This page is part of the FHIR Specification (v3.0.2: STU 3). 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
Structured Documents Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
Generic example
@prefix fhir: <http://hl7.org/fhir/> . @prefix loinc: <http://loinc.org/owl#> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource ------------------------------------------------------------------- <http://hl7.org/fhir/DocumentReference/example> a fhir:DocumentReference; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "example"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>contained</b>: </p><p><b>masterIdentifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: current</p><p><b>docStatus</b>: preliminary</p><p><b>type</b>: Outpatient Note <span>(Details : {LOINC code '34108-1' = 'Outpatient Note', given as 'Outpatient Note'})</span></p><p><b>class</b>: History and Physical <span>(Details : {http://ihe.net/xds/connectathon/classCodes code 'History and Physical' = 'History and Physical', given as 'History and Physical'})</span></p><p><b>subject</b>: <a>Patient/xcda</a></p><p><b>created</b>: 24/12/2005 9:35:00 AM</p><p><b>indexed</b>: 24/12/2005 9:43:41 AM</p><p><b>author</b>: <a>Practitioner/xcda1</a>, id: a2; Gerald Smitty </p><p><b>authenticator</b>: <a>Organization/f001</a></p><p><b>custodian</b>: <a>Organization/f001</a></p><h3>RelatesTos</h3><table><tr><td>-</td><td><b>Code</b></td><td><b>Target</b></td></tr><tr><td>*</td><td>appends</td><td><a>DocumentReference/example</a></td></tr></table><p><b>description</b>: Physical</p><p><b>securityLabel</b>: very restricted <span>(Details : {http://hl7.org/fhir/v3/Confidentiality code 'V' = 'very restricted', given as 'very restricted'})</span></p><h3>Contents</h3><table><tr><td>-</td><td><b>Attachment</b></td><td><b>Format</b></td></tr><tr><td>*</td><td/><td>History and Physical Specification (Details: urn:oid:1.3.6.1.4.1.19376.1.2.3 code urn:ihe:pcc:handp:2008 = 'urn:ihe:pcc:handp:2008', stated as 'History and Physical Specification')</td></tr></table><blockquote><p><b>context</b></p><p><b>encounter</b>: <a>Encounter/xcda</a></p><p><b>event</b>: Arm <span>(Details : {http://ihe.net/xds/connectathon/eventCodes code 'T-D8200' = 'T-D8200', given as 'Arm'})</span></p><p><b>period</b>: 23/12/2004 8:00:00 AM --> 23/12/2004 8:01:00 AM</p><p><b>facilityType</b>: Outpatient <span>(Details : {http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes code 'Outpatient' = 'Outpatient', given as 'Outpatient'})</span></p><p><b>practiceSetting</b>: General Medicine <span>(Details : {http://www.ihe.net/xds/connectathon/practiceSettingCodes code 'General Medicine' = 'General Medicine', given as 'General Medicine'})</span></p><p><b>sourcePatientInfo</b>: <a>Patient/xcda</a></p><h3>Relateds</h3><table><tr><td>-</td><td><b>Identifier</b></td><td><b>Ref</b></td></tr><tr><td>*</td><td>urn:oid:1.3.6.1.4.1.21367.2005.3.7.2345</td><td><a>Patient/xcda</a></td></tr></table></blockquote></div>" ]; fhir:DomainResource.contained [ a fhir:Practitioner; fhir:index 0; fhir:Resource.id [ fhir:value "a2" ]; fhir:Practitioner.name [ fhir:index 0; fhir:HumanName.family [ fhir:value "Smitty" ]; fhir:HumanName.given [ fhir:value "Gerald"; fhir:index 0 ] ] ]; fhir:DocumentReference.masterIdentifier [ fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ]; fhir:Identifier.value [ fhir:value "urn:oid:1.3.6.1.4.1.21367.2005.3.7" ] ]; fhir:DocumentReference.identifier [ fhir:index 0; fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ]; fhir:Identifier.value [ fhir:value "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234" ] ]; fhir:DocumentReference.status [ fhir:value "current"]; fhir:DocumentReference.docStatus [ fhir:value "preliminary"]; fhir:DocumentReference.type [ fhir:CodeableConcept.coding [ fhir:index 0; a loinc:34108-1; fhir:Coding.system [ fhir:value "http://loinc.org" ]; fhir:Coding.code [ fhir:value "34108-1" ]; fhir:Coding.display [ fhir:value "Outpatient Note" ] ] ]; fhir:DocumentReference.class [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://ihe.net/xds/connectathon/classCodes" ]; fhir:Coding.code [ fhir:value "History and Physical" ]; fhir:Coding.display [ fhir:value "History and Physical" ] ] ]; fhir:DocumentReference.subject [ fhir:link <http://hl7.org/fhir/Patient/xcda>; fhir:Reference.reference [ fhir:value "Patient/xcda" ] ]; fhir:DocumentReference.created [ fhir:value "2005-12-24T09:35:00+11:00"^^xsd:dateTime]; fhir:DocumentReference.indexed [ fhir:value "2005-12-24T09:43:41+11:00"^^xsd:dateTime]; fhir:DocumentReference.author [ fhir:index 0; fhir:link <http://hl7.org/fhir/Practitioner/xcda1>; fhir:Reference.reference [ fhir:value "Practitioner/xcda1" ] ], [ fhir:index 1; fhir:Reference.reference [ fhir:value "#a2" ] ]; fhir:DocumentReference.authenticator [ fhir:link <http://hl7.org/fhir/Organization/f001>; fhir:Reference.reference [ fhir:value "Organization/f001" ] ]; fhir:DocumentReference.custodian [ fhir:link <http://hl7.org/fhir/Organization/f001>; fhir:Reference.reference [ fhir:value "Organization/f001" ] ]; fhir:DocumentReference.relatesTo [ fhir:index 0; fhir:DocumentReference.relatesTo.code [ fhir:value "appends" ]; fhir:DocumentReference.relatesTo.target [ fhir:link <http://hl7.org/fhir/DocumentReference/example>; fhir:Reference.reference [ fhir:value "DocumentReference/example" ] ] ]; fhir:DocumentReference.description [ fhir:value "Physical"]; fhir:DocumentReference.securityLabel [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://hl7.org/fhir/v3/Confidentiality" ]; fhir:Coding.code [ fhir:value "V" ]; fhir:Coding.display [ fhir:value "very restricted" ] ] ]; fhir:DocumentReference.content [ fhir:index 0; fhir:DocumentReference.content.attachment [ fhir:Attachment.contentType [ fhir:value "application/hl7-v3+xml" ]; fhir:Attachment.language [ fhir:value "en-US" ]; fhir:Attachment.url [ fhir:value "http://example.org/xds/mhd/Binary/07a6483f-732b-461e-86b6-edb665c45510" ]; fhir:Attachment.size [ fhir:value "3654"^^xsd:nonNegativeInteger ]; fhir:Attachment.hash [ fhir:value "2jmj7l5rSw0yVb/vlWAYkK/YBwk="^^xsd:base64Binary ] ]; fhir:DocumentReference.content.format [ fhir:Coding.system [ fhir:value "urn:oid:1.3.6.1.4.1.19376.1.2.3" ]; fhir:Coding.code [ fhir:value "urn:ihe:pcc:handp:2008" ]; fhir:Coding.display [ fhir:value "History and Physical Specification" ] ] ]; fhir:DocumentReference.context [ fhir:DocumentReference.context.encounter [ fhir:link <http://hl7.org/fhir/Encounter/xcda>; fhir:Reference.reference [ fhir:value "Encounter/xcda" ] ]; fhir:DocumentReference.context.event [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://ihe.net/xds/connectathon/eventCodes" ]; fhir:Coding.code [ fhir:value "T-D8200" ]; fhir:Coding.display [ fhir:value "Arm" ] ] ]; fhir:DocumentReference.context.period [ fhir:Period.start [ fhir:value "2004-12-23T08:00:00+11:00"^^xsd:dateTime ]; fhir:Period.end [ fhir:value "2004-12-23T08:01:00+11:00"^^xsd:dateTime ] ]; fhir:DocumentReference.context.facilityType [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes" ]; fhir:Coding.code [ fhir:value "Outpatient" ]; fhir:Coding.display [ fhir:value "Outpatient" ] ] ]; fhir:DocumentReference.context.practiceSetting [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://www.ihe.net/xds/connectathon/practiceSettingCodes" ]; fhir:Coding.code [ fhir:value "General Medicine" ]; fhir:Coding.display [ fhir:value "General Medicine" ] ] ]; fhir:DocumentReference.context.sourcePatientInfo [ fhir:link <http://hl7.org/fhir/Patient/xcda>; fhir:Reference.reference [ fhir:value "Patient/xcda" ] ]; fhir:DocumentReference.context.related [ fhir:index 0; fhir:DocumentReference.context.related.identifier [ fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ]; fhir:Identifier.value [ fhir:value "urn:oid:1.3.6.1.4.1.21367.2005.3.7.2345" ] ]; fhir:DocumentReference.context.related.ref [ fhir:link <http://hl7.org/fhir/Patient/xcda>; fhir:Reference.reference [ fhir:value "Patient/xcda" ] ] ] ] . <http://hl7.org/fhir/Patient/xcda> a fhir:Patient . <http://hl7.org/fhir/Practitioner/xcda1> a fhir:Practitioner . <http://hl7.org/fhir/Organization/f001> a fhir:Organization . <http://hl7.org/fhir/Encounter/xcda> a fhir:Encounter . # - ontology header ------------------------------------------------------------ <http://hl7.org/fhir/DocumentReference/example.ttl> a owl:Ontology; owl:imports fhir:fhir.ttl; owl:versionIRI <http://hl7.org/fhir/STU3/DocumentReference/example.ttl> . # -------------------------------------------------------------------------------------
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.