US Core Implementation Guide (Release 1.1.0 Ballot )
This page is part of the US Core (v1.1.0: STU2 Ballot 1) based on FHIR R3. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
Formats: Narrative, XML, JSON, Turtle
Raw xml
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="us-core-documentreference"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference" title="This is a basic constraint on DocumentRefernce for use in the US Core IG.">DocumentReference</a><a name="DocumentReference"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">US Core DocumentReference Profile</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.identifier">identifier</a><a name="DocumentReference.identifier"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span>..<span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#Identifier">Identifier</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.status">status</a><a name="DocumentReference.status"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="http://hl7.org/fhir/STU3/valueset-document-reference-status.html">DocumentReferenceStatus</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set">required</a>)</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.type">type</a><a name="DocumentReference.type"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="http://hl7.org/fhir/STU3/valueset-c80-doc-typecodes.html">Document Type Value Set</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set">required</a>)</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.subject">subject</a><a name="DocumentReference.subject"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-us-core-patient.html">US Core Patient Profile</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.created">created</a><a name="DocumentReference.created"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#dateTime">dateTime</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.content">content</a><a name="DocumentReference.content"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span>..<span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#BackboneElement">BackboneElement</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck111.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.content.attachment">attachment</a><a name="DocumentReference.content.attachment"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#Attachment">Attachment</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1110.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.content.attachment.contentType">contentType</a><a name="DocumentReference.content.attachment.contentType"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.content.attachment.url">url</a><a name="DocumentReference.content.attachment.url"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.content.format">format</a><a name="DocumentReference.content.format"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#Coding">Coding</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="http://hl7.org/fhir/STU3/valueset-formatcodes.html">DocumentReference Format Code Set</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.context">context</a><a name="DocumentReference.context"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#BackboneElement">BackboneElement</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-us-core-documentreference-definitions.html#DocumentReference.context.encounter">encounter</a><a name="DocumentReference.context.encounter"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-us-core-encounter.html">US Core Encounter Profile</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"/> <version value="1.1.0"/> <name value="US Core DocumentReference Profile"/> <status value="draft"/> <date value="2017-12-10T00:00:00+11:00"/> <publisher value="HL7 US Realm Steering Committee"/> <contact> <telecom> <system value="url"/> <value value="http://www.healthit.gov"/> </telecom> </contact> <description value="The document reference profile used in US Core."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> <display value="United States Minor Outlying Islands (the)"/> </coding> </jurisdiction> <fhirVersion value="3.0.1"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2 Mapping"/> </mapping> <mapping> <identity value="xds"/> <uri value="http://ihe.net/xds"/> <name value="XDS metadata equivalent"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="DocumentReference"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DocumentReference"/> <derivation value="constraint"/> <snapshot> <element id="DocumentReference"> <path value="DocumentReference"/> <short value="US Core DocumentReference Profile"/> <definition value="This is a basic constraint on DocumentRefernce for use in the US Core IG."/> <comment value="Usually, this is used for documents other than those defined by FHIR."/> <min value="0"/> <max value="*"/> <base> <path value="DocumentReference"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/> <source value="DomainResource"/> </constraint> <mustSupport value="false"/> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="rim"/> <map value="Document[classCode="DOC" and moodCode="EVN"]"/> </mapping> <mapping> <identity value="w5"/> <map value="infrastructure.documents"/> </mapping> </element> <element id="DocumentReference.id"> <path value="DocumentReference.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element id="DocumentReference.meta"> <path value="DocumentReference.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element id="DocumentReference.implicitRules"> <path value="DocumentReference.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="DocumentReference.language"> <path value="DocumentReference.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="DocumentReference.text"> <path value="DocumentReference.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="DocumentReference.contained"> <path value="DocumentReference.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DocumentReference.extension"> <path value="DocumentReference.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DocumentReference.modifierExtension"> <path value="DocumentReference.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DocumentReference.masterIdentifier"> <path value="DocumentReference.masterIdentifier"/> <short value="Master Version Specific Identifier"/> <definition value="Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document."/> <comment value="CDA Document Id extension and root."/> <requirements value="The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.)."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.masterIdentifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="TXA-12"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.uniqueId"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element id="DocumentReference.identifier"> <path value="DocumentReference.identifier"/> <short value="Other identifiers for the document"/> <definition value="Other identifiers associated with the document, including version independent identifiers."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="TXA-16?"/> </mapping> <mapping> <identity value="rim"/> <map value=".id / .setId"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.entryUUID"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element id="DocumentReference.status"> <path value="DocumentReference.status"/> <short value="current | superseded | entered-in-error"/> <definition value="The status of this document reference."/> <comment value="This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid."/> <min value="1"/> <max value="1"/> <base> <path value="DocumentReference.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/document-reference-status"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="TXA-19"/> </mapping> <mapping> <identity value="rim"/> <map value="interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete""/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry status"/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </mapping> </element> <element id="DocumentReference.docStatus"> <path value="DocumentReference.docStatus"/> <short value="preliminary | final | appended | amended | entered-in-error"/> <definition value="The status of the underlying document."/> <comment value="The document that is pointed to might be in various lifecycle states."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.docStatus"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ReferredDocumentStatus"/> </extension> <strength value="required"/> <description value="Status of the underlying document."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/composition-status"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="TXA-17"/> </mapping> <mapping> <identity value="rim"/> <map value=".statusCode"/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </mapping> </element> <element id="DocumentReference.type"> <path value="DocumentReference.type"/> <short value="Kind of document (LOINC if possible)"/> <definition value="Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced."/> <comment value="Key metadata element describing the document, used in searching/filtering."/> <min value="1"/> <max value="1"/> <base> <path value="DocumentReference.type"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/c80-doc-typecodes"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="TXA-2"/> </mapping> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.type"/> </mapping> <mapping> <identity value="w5"/> <map value="class"/> </mapping> </element> <element id="DocumentReference.class"> <path value="DocumentReference.class"/> <short value="Categorization of document"/> <definition value="A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type."/> <comment value="This is a metadata field from [XDS/MHD](http://wiki.ihe.net/index.php?title=Mobile_access_to_Health_Documents_(MHD))."/> <requirements value="Helps humans to assess whether the document is of interest when viewing a list of documents."/> <alias value="kind"/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.class"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="DocumentC80Class"/> </extension> <strength value="example"/> <description value="High-level kind of a clinical document at a macro level."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/c80-doc-classcodes"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.class"/> </mapping> <mapping> <identity value="w5"/> <map value="class"/> </mapping> </element> <element id="DocumentReference.subject"> <path value="DocumentReference.subject"/> <short value="Who/what is the subject of the document"/> <definition value="Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)."/> <min value="1"/> <max value="1"/> <base> <path value="DocumentReference.subject"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode="SBJ"].role[typeCode="PAT"]"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.patientId"/> </mapping> <mapping> <identity value="w5"/> <map value="who.focus"/> </mapping> </element> <element id="DocumentReference.created"> <path value="DocumentReference.created"/> <short value="Document creation time"/> <definition value="When the document was created."/> <comment value="Creation time is used for tracking, organizing versions and searching. This is the creation time of the document, not the source material on which it is based."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.created"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="TXA-6"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime[type="TS"]"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.submissionTime"/> </mapping> <mapping> <identity value="w5"/> <map value="when.done"/> </mapping> </element> <element id="DocumentReference.indexed"> <path value="DocumentReference.indexed"/> <short value="When this document reference was created"/> <definition value="When the document reference was created."/> <comment value="Referencing/indexing time is used for tracking, organizing versions and searching."/> <min value="1"/> <max value="1"/> <base> <path value="DocumentReference.indexed"/> <min value="1"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".availabilityTime[type="TS"]"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.submissionTime"/> </mapping> <mapping> <identity value="w5"/> <map value="when.recorded"/> </mapping> </element> <element id="DocumentReference.author"> <path value="DocumentReference.author"/> <short value="Who and/or what authored the document"/> <definition value="Identifies who is responsible for adding the information to the document."/> <comment value="Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant)."/> <min value="0"/> <max value="*"/> <base> <path value="DocumentReference.author"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode="AUT"].role[classCode="ASSIGNED"]"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.author"/> </mapping> <mapping> <identity value="w5"/> <map value="who.author"/> </mapping> </element> <element id="DocumentReference.authenticator"> <path value="DocumentReference.authenticator"/> <short value="Who/what authenticated the document"/> <definition value="Which person or organization authenticates that this document is valid."/> <comment value="Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.authenticator"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="TXA-10"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.legalAuthenticator"/> </mapping> <mapping> <identity value="w5"/> <map value="who.witness"/> </mapping> </element> <element id="DocumentReference.custodian"> <path value="DocumentReference.custodian"/> <short value="Organization which maintains the document"/> <definition value="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document."/> <comment value="Identifies the logical organization to go to find the current version, where to report issues, etc. This is different from the physical location of the document, which is the technical location of the document, which host may be delegated to the management of some other organization."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.custodian"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]"/> </mapping> </element> <element id="DocumentReference.relatesTo"> <path value="DocumentReference.relatesTo"/> <short value="Relationships to other documents"/> <definition value="Relationships that this document has with other document references that already exist."/> <comment value="This element is labeled as a modifier because documents that append to other documents are incomplete on their own."/> <min value="0"/> <max value="*"/> <base> <path value="DocumentReference.relatesTo"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship"/> </mapping> </element> <element id="DocumentReference.relatesTo.id"> <path value="DocumentReference.relatesTo.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.relatesTo.extension"> <path value="DocumentReference.relatesTo.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.relatesTo.modifierExtension"> <path value="DocumentReference.relatesTo.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DocumentReference.relatesTo.code"> <path value="DocumentReference.relatesTo.code"/> <short value="replaces | transforms | signs | appends"/> <definition value="The type of relationship that this document has with anther document."/> <comment value="If this document appends another document, then the document cannot be fully understood without also accessing the referenced document."/> <min value="1"/> <max value="1"/> <base> <path value="DocumentReference.relatesTo.code"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="DocumentRelationshipType"/> </extension> <strength value="required"/> <description value="The type of relationship between documents."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/document-relationship-type"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".outboundRelationship.typeCode"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry Associations type"/> </mapping> </element> <element id="DocumentReference.relatesTo.target"> <path value="DocumentReference.relatesTo.target"/> <short value="Target of the relationship"/> <definition value="The target document of this relationship."/> <min value="1"/> <max value="1"/> <base> <path value="DocumentReference.relatesTo.target"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentReference"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".target[classCode="DOC", moodCode="EVN"].id"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry Associations reference"/> </mapping> </element> <element id="DocumentReference.description"> <path value="DocumentReference.description"/> <short value="Human-readable description (title)"/> <definition value="Human-readable description of the source document. This is sometimes known as the "title"."/> <comment value="What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a "consultation" or "progress note")."/> <requirements value="Helps humans to assess whether the document is of interest."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="TXA-25"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="SUBJ"].target.text"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.description"/> </mapping> </element> <element id="DocumentReference.securityLabel"> <path value="DocumentReference.securityLabel"/> <short value="Document security-tags"/> <definition value="A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to."/> <comment value="The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects."/> <requirements value="Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended."/> <min value="0"/> <max value="*"/> <base> <path value="DocumentReference.securityLabel"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SecurityLabels"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="Security Labels from the Healthcare Privacy and Security Classification System."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/security-labels"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="TXA-18"/> </mapping> <mapping> <identity value="rim"/> <map value=".confidentialityCode"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.confidentialityCode"/> </mapping> </element> <element id="DocumentReference.content"> <path value="DocumentReference.content"/> <short value="Document referenced"/> <definition value="The document and format referenced. There may be multiple content element repetitions, each with a different format."/> <min value="1"/> <max value="1"/> <base> <path value="DocumentReference.content"/> <min value="1"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="document.text"/> </mapping> </element> <element id="DocumentReference.content.id"> <path value="DocumentReference.content.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.content.extension"> <path value="DocumentReference.content.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.content.modifierExtension"> <path value="DocumentReference.content.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DocumentReference.content.attachment"> <path value="DocumentReference.content.attachment"/> <short value="Where to access the document"/> <definition value="The document or URL of the document along with critical metadata to prove content has integrity."/> <min value="1"/> <max value="1"/> <base> <path value="DocumentReference.content.attachment"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Attachment"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="TXA-3 for mime type"/> </mapping> <mapping> <identity value="rim"/> <map value="document.text"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.mimeType DocumentEntry.languageCode DocumentEntry.URI DocumentEntry.size DocumentEntry.hash DocumentEntry.title"/> </mapping> </element> <element id="DocumentReference.content.attachment.id"> <path value="DocumentReference.content.attachment.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.content.attachment.extension"> <path value="DocumentReference.content.attachment.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.content.attachment.contentType"> <path value="DocumentReference.content.attachment.contentType"/> <short value="Mime type of the content, with charset etc."/> <definition value="Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate."/> <requirements value="Processors of the data need to be able to know how to interpret the data."/> <min value="1"/> <max value="1"/> <base> <path value="Attachment.contentType"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <example> <label value="General"/> <valueCode value="text/plain; charset=UTF-8, image/png"/> </example> <mustSupport value="true"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="MimeType"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="The mime type of an attachment. Any valid mime type is allowed."/> <valueSetUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/> </binding> <mapping> <identity value="v2"/> <map value="ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used"/> </mapping> <mapping> <identity value="rim"/> <map value="./mediaType, ./charset"/> </mapping> </element> <element id="DocumentReference.content.attachment.language"> <path value="DocumentReference.content.attachment.language"/> <short value="Human language of the content (BCP-47)"/> <definition value="The human language of the content. The value can be any valid value according to BCP 47."/> <requirements value="Users need to be able to choose between the languages in a set of attachments."/> <min value="0"/> <max value="1"/> <base> <path value="Attachment.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <example> <label value="General"/> <valueCode value="en-AU"/> </example> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="./language"/> </mapping> </element> <element id="DocumentReference.content.attachment.data"> <path value="DocumentReference.content.attachment.data"/> <short value="Data inline, base64ed"/> <definition value="The actual data of the attachment - a sequence of bytes. In XML, represented using base64."/> <comment value="The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON."/> <requirements value="The data needs to able to be transmitted inline."/> <min value="0"/> <max value="1"/> <base> <path value="Attachment.data"/> <min value="0"/> <max value="1"/> </base> <type> <code value="base64Binary"/> </type> <mapping> <identity value="v2"/> <map value="ED.5"/> </mapping> <mapping> <identity value="rim"/> <map value="./data"/> </mapping> </element> <element id="DocumentReference.content.attachment.url"> <path value="DocumentReference.content.attachment.url"/> <short value="Uri where the data can be found"/> <definition value="An alternative location where the data can be accessed."/> <comment value="If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data."/> <requirements value="The data needs to be transmitted by reference."/> <min value="1"/> <max value="1"/> <base> <path value="Attachment.url"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <example> <label value="General"/> <valueUri value="http://www.acme.com/logo-small.png"/> </example> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="RP.1+RP.2 - if they refer to a URL (see v2.6)"/> </mapping> <mapping> <identity value="rim"/> <map value="./reference/literal"/> </mapping> </element> <element id="DocumentReference.content.attachment.size"> <path value="DocumentReference.content.attachment.size"/> <short value="Number of bytes of content (if url provided)"/> <definition value="The number of bytes of data that make up this attachment (before base64 encoding, if that is done)."/> <comment value="The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference."/> <requirements value="Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all."/> <min value="0"/> <max value="1"/> <base> <path value="Attachment.size"/> <min value="0"/> <max value="1"/> </base> <type> <code value="unsignedInt"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (needs data type R3 proposal)"/> </mapping> </element> <element id="DocumentReference.content.attachment.hash"> <path value="DocumentReference.content.attachment.hash"/> <short value="Hash of the data (sha-1, base64ed)"/> <definition value="The calculated hash of the data using SHA-1. Represented using base64."/> <comment value="The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded."/> <requirements value="Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature."/> <min value="0"/> <max value="1"/> <base> <path value="Attachment.hash"/> <min value="0"/> <max value="1"/> </base> <type> <code value="base64Binary"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]"/> </mapping> </element> <element id="DocumentReference.content.attachment.title"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="DocumentReference.content.attachment.title"/> <short value="Label to display in place of the data"/> <definition value="A label or set of text to display in place of the data."/> <requirements value="Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer."/> <min value="0"/> <max value="1"/> <base> <path value="Attachment.title"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <example> <label value="General"/> <valueString value="Official Corporate Logo"/> </example> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./title/data"/> </mapping> </element> <element id="DocumentReference.content.attachment.creation"> <path value="DocumentReference.content.attachment.creation"/> <short value="Date attachment was first created"/> <definition value="The date that the attachment was first created."/> <requirements value="This is often tracked as an integrity issue for use of the attachment."/> <min value="0"/> <max value="1"/> <base> <path value="Attachment.creation"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (needs data type R3 proposal)"/> </mapping> </element> <element id="DocumentReference.content.format"> <path value="DocumentReference.content.format"/> <short value="Format/content rules for the document"/> <definition value="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType."/> <comment value="Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI."/> <min value="1"/> <max value="1"/> <base> <path value="DocumentReference.content.format"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/formatcodes"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="document.text"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.formatCode"/> </mapping> </element> <element id="DocumentReference.context"> <path value="DocumentReference.context"/> <short value="Clinical context of document"/> <definition value="The clinical context in which the document was prepared."/> <comment value="These values are primarily added to help with searching for interesting/relevant documents."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.context"/> <min value="0"/> <max value="1"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']"/> </mapping> </element> <element id="DocumentReference.context.id"> <path value="DocumentReference.context.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.context.extension"> <path value="DocumentReference.context.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.context.modifierExtension"> <path value="DocumentReference.context.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DocumentReference.context.encounter"> <path value="DocumentReference.context.encounter"/> <short value="Context of the document content"/> <definition value="Describes the clinical encounter or type of care that the document content is associated with."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.context.encounter"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])"/> </mapping> <mapping> <identity value="w5"/> <map value="context"/> </mapping> </element> <element id="DocumentReference.context.event"> <path value="DocumentReference.context.event"/> <short value="Main clinical acts documented"/> <definition value="This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act."/> <comment value="An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation."/> <min value="0"/> <max value="*"/> <base> <path value="DocumentReference.context.event"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="DocumentEventType"/> </extension> <strength value="example"/> <description value="This list of codes represents the main clinical acts being documented."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/v3-ActCode"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.eventCodeList"/> </mapping> </element> <element id="DocumentReference.context.period"> <path value="DocumentReference.context.period"/> <short value="Time of service that is being documented"/> <definition value="The time period over which the service that is described by the document was provided."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.context.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.serviceStartTime DocumentEntry.serviceStopTime"/> </mapping> </element> <element id="DocumentReference.context.facilityType"> <path value="DocumentReference.context.facilityType"/> <short value="Kind of facility where patient was seen"/> <definition value="The kind of facility where the patient was seen."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.context.facilityType"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="DocumentC80FacilityType"/> </extension> <strength value="example"/> <description value="XDS Facility Type."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/c80-facilitycodes"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".participation[typeCode="LOC"].role[classCode="DSDLOC"].code"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.healthcareFacilityTypeCode"/> </mapping> </element> <element id="DocumentReference.context.practiceSetting"> <path value="DocumentReference.context.practiceSetting"/> <short value="Additional details about where the content was created (e.g. clinical specialty)"/> <definition value="This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty."/> <comment value="The value set for this content has an example binding because it is a value set decided by community policy. Other examples exist for consideration: * HITSP created the table HITSP/C80 Table 2-148 Clinical Specialty Value Set (a value set based upon SNOMED CT which is referenced by Direct (XDR and XDM for Direct Messaging Specification, Version 1), as well as Nationwide Health Information Network (NHIN). Query for Documents, Web Service Interface Specification, V 3.0, 07/27/2011 * ELGA (Austria) (ELGA CDA Implementie-rungsleitfäden Registrierung von CDA Dokumenten für ELGA mit IHE Cross-Enterprise Document Sharing: XDS Metadaten (XDSDocumentEntry), [1.2.40.0.34.7.6.3] * XDS Connect-a-thon practiceSettingCode."/> <requirements value="This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.context.practiceSetting"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="DocumentC80PracticeSetting"/> </extension> <strength value="example"/> <description value="Additional details about where the content was created (e.g. clinical specialty)."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/c80-practice-codes"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".participation[typeCode="LOC"].role[classCode="DSDLOC"].code"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.practiceSettingCode"/> </mapping> </element> <element id="DocumentReference.context.sourcePatientInfo"> <path value="DocumentReference.context.sourcePatientInfo"/> <short value="Patient demographics from source"/> <definition value="The Patient Information as known when the document was published. May be a reference to a version specific, or contained."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.context.sourcePatientInfo"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode="SBJ"].role[typeCode="PAT"]"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.sourcePatientInfo DocumentEntry.sourcePatientId"/> </mapping> </element> <element id="DocumentReference.context.related"> <path value="DocumentReference.context.related"/> <short value="Related identifiers or resources"/> <definition value="Related identifiers or resources associated with the DocumentReference."/> <comment value="May be identifiers or resources that caused the DocumentReference or referenced Document to be created."/> <min value="0"/> <max value="*"/> <base> <path value="DocumentReference.context.related"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct]"/> </mapping> <mapping> <identity value="xds"/> <map value="DocumentEntry.referenceIdList"/> </mapping> </element> <element id="DocumentReference.context.related.id"> <path value="DocumentReference.context.related.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.context.related.extension"> <path value="DocumentReference.context.related.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="DocumentReference.context.related.modifierExtension"> <path value="DocumentReference.context.related.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DocumentReference.context.related.identifier"> <path value="DocumentReference.context.related.identifier"/> <short value="Identifier of related objects or events"/> <definition value="Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing."/> <comment value="Order numbers, accession numbers, XDW workflow numbers."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.context.related.identifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct] .id"/> </mapping> </element> <element id="DocumentReference.context.related.ref"> <path value="DocumentReference.context.related.ref"/> <short value="Related Resource"/> <definition value="Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing."/> <comment value="Order, ProcedureRequest, Procedure, EligibilityRequest, etc."/> <min value="0"/> <max value="1"/> <base> <path value="DocumentReference.context.related.ref"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct].text.reference"/> </mapping> </element> </snapshot> <differential> <element id="DocumentReference"> <path value="DocumentReference"/> <short value="US Core DocumentReference Profile"/> <definition value="This is a basic constraint on DocumentRefernce for use in the US Core IG."/> <mustSupport value="false"/> <isModifier value="false"/> </element> <element id="DocumentReference.identifier"> <path value="DocumentReference.identifier"/> <min value="0"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="DocumentReference.status"> <path value="DocumentReference.status"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> <binding> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/document-reference-status"/> </valueSetReference> </binding> </element> <element id="DocumentReference.type"> <path value="DocumentReference.type"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> <binding> <strength value="required"/> <description value="Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/c80-doc-typecodes"/> </valueSetReference> </binding> </element> <element id="DocumentReference.subject"> <path value="DocumentReference.subject"/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/> </type> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="DocumentReference.created"> <path value="DocumentReference.created"/> <min value="0"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="DocumentReference.content"> <path value="DocumentReference.content"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="DocumentReference.content.attachment"> <path value="DocumentReference.content.attachment"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="DocumentReference.content.attachment.contentType"> <path value="DocumentReference.content.attachment.contentType"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="DocumentReference.content.attachment.url"> <path value="DocumentReference.content.attachment.url"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="DocumentReference.content.format"> <path value="DocumentReference.content.format"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/formatcodes"/> </valueSetReference> </binding> </element> <element id="DocumentReference.context"> <path value="DocumentReference.context"/> <min value="0"/> <max value="1"/> <mustSupport value="true"/> <isModifier value="false"/> </element> <element id="DocumentReference.context.encounter"> <path value="DocumentReference.context.encounter"/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"/> </type> <mustSupport value="true"/> <isModifier value="false"/> </element> </differential> </StructureDefinition>
US Core Version: 1.1.0 ®© FHIR Version: 3.0.1 (IG Publisher v3.0.1-11917) generated on Wed, Dec 20, 2017 12:39+1100. |
