. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.11: DSTU 1 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Profile for documentreference
<Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="documentreference-definitions.htm#DocumentReference" title="A reference to a document."><b>DocumentReference</b></a> xmlns="http://hl7.org/fhir"> <!-- from <a href="resources.htm">Resource</a>: <a href="extensibility.htm">extension</a>, <a href="narrative.htm#Narrative">narrative</a>, and <a href="references.htm#contained">contained</a> --> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.masterIdentifier" title="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."><b>masterIdentifier</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.htm#Identifier">Identifier</a></span> <span style="color: navy">Master Version Specific Identifier</span><span style="color: Gray"> --></span></masterIdentifier> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.identifier" title="Other identifiers associated with the record."><b>identifier</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.htm#Identifier">Identifier</a></span> <span style="color: navy">Other identifiers for the document</span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.subject" title="Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. 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)."><b>subject</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.htm#Resource">Resource</a>(<a href="patient.htm#Patient">Patient</a>|<a href="practitioner.htm#Practitioner">Practitioner</a>|<a href="group.htm#Group">Group</a>|<a href="device.htm#Device">Device</a>)</span> <span style="color: navy">The subject of the document</span><span style="color: Gray"> --></span></subject> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.type" title="Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)."><b>type</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.htm#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-doc-codes.htm" style="color: navy">What kind of document this is (LOINC if possible)</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.subtype" title="More detailed information about the document type."><b>subtype</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.htm#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-xds-typecodes.htm" style="color: navy">More detail about the document type</a></span><span style="color: Gray"> --></span></subtype> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.author" title="Identifies who is responsible for adding the information to the document."><b>author</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..*</b></span> <span style="color: darkgreen"><a href="references.htm#Resource">Resource</a>(<a href="practitioner.htm#Practitioner">Practitioner</a>|<a href="device.htm#Device">Device</a>)</span> <span style="color: navy">Who/what authored the document</span><span style="color: Gray"> --></span></author> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.custodian" title="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document."><b>custodian</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.htm#Resource">Resource</a>(<a href="organization.htm#Organization">Organization</a>)</span> <span style="color: navy">Org which maintains the document</span><span style="color: Gray"> --></span></custodian> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.authenticator" title="Which person or organization authenticates that this document is valid."><b>authenticator</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.htm#Resource">Resource</a>(<a href="practitioner.htm#Practitioner">Practitioner</a>|<a href="organization.htm#Organization">Organization</a>)</span> <span style="color: navy">Who authenticated the document</span><span style="color: Gray"> --></span></authenticator> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.created" title="When the document was created."><b>created</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#dateTime">dateTime</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Document creation time</span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.indexed" title="When the document reference was created."><b>indexed</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#instant">instant</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">When this document reference created</span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.status" title="The status of this document reference (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>status</b></span></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="document-reference-status.htm" style="color: navy">current | superseded | error</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.docStatus" title="The status of the underlying document."><b>docStatus</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.htm#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="http://hl7.org/fhir/vs/document-status.htm" style="color: navy">Status of the underlying document</a></span><span style="color: Gray"> --></span></docStatus> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.supercedes" title="If this document replaces another (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>supercedes</b></span></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.htm#Resource">Resource</a>(<a href="documentreference.htm#DocumentReference">DocumentReference</a>)</span> <span style="color: navy">If this document replaces another</span><span style="color: Gray"> --></span></supercedes> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.description" title="Human Readable description of the source document. This is sometimes known as the "title"."><b>description</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Human Readable description (title)</span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.confidentiality" title="A code specifying the level of confidentiality of the XDS Document (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>confidentiality</b></span></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.htm#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-doc-confidentiality.htm" style="color: navy">Sensitivity of source document</a></span><span style="color: Gray"> --></span></confidentiality> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.primaryLanguage" title="The primary language in which the source document is written."><b>primaryLanguage</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy"><a href="http://tools.ietf.org/html/bcp47.htm" style="color: navy">Primary language of the document</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.mimeType" title="The mime type of the source document."><b>mimeType</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#code">code</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="http://www.rfc-editor.org/bcp/bcp13.txt.htm" style="color: navy">Mime type of the document</a></span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.format" title="The format of the document. This is used when the mimeType of the document does not provide enough differentiating information (typically, when the mime type of the document is text/xml)."><b>format</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.htm#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-xds-formatcodes.htm" style="color: navy">Format of the document</a></span><span style="color: Gray"> --></span></format> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.size" title="The size of the source document this reference refers to in bytes."><b>size</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#integer">integer</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Size of the document in bytes</span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.hash" title="A hash of the source document to ensure that changes have not occurred."><b>hash</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">HexBinary representation of SHA1</span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.location" title="A url at which the document can be accessed."><b>location</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#uri">uri</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: deeppink" title="Inv-1: A location or a service (or both) must be provided"><b>0..1</b></span> <span style="color: navy">Where to access the document</span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.service" title="A description of a service call that can be used to retrieve the document."><b>service</b></a>> <span style="color: Gray"><!-- <span style="color: deeppink" title="Inv-1: A location or a service (or both) must be provided"><b>0..1</b></span> If access is not fully described by location --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.service.type" title="The type of the service that can be used to access the documents."><b>type</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.htm#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-documentreference-service-types.htm" style="color: navy">Type of service (i.e. XDS.b)</a></span><span style="color: Gray"> --></span></type> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.service.address" title="Where the service end-point is located."><b>address</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Where service is located (usually a URL)</span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.service.parameter" title="A list of named parameters that is used in the service call."><b>parameter</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Service call parameters --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.service.parameter.name" title="The name of a parameter."><b>name</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Name of parameter</span><span style="color: Gray"> --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.service.parameter.value" title="The value of the named parameter."><b>value</b></a> value="[<span style="color: darkgreen"><a href="datatypes.htm#string">string</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Parameter value</span><span style="color: Gray"> --></span> </parameter> </service> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.context" title="The clinical context in which the document was prepared."><b>context</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..1</b></span> Clinical context of document --></span> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.context.code" title="The type of clinical context, such as a kind of surgery, or a kind of speciality, or a clinical type."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.htm#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-doc-event-code.htm" style="color: navy">Type of context (i.e. type of event)</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.context.period" title="The time period of the patient's care that is described by the document."><b>period</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.htm#Period">Period</a></span> <span style="color: navy">Time described by the document</span><span style="color: Gray"> --></span></period> <<a class="dict" href="documentreference-definitions.htm#DocumentReference.context.facilityType" title="The kind of facility where the patient was seen."><b>facilityType</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.htm#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-xds-facilitycodes.htm" style="color: navy">Kind of facility where patient was seen</a></span><span style="color: Gray"> --></span></facilityType> </context> </DocumentReference> </pre></div> </text> <name value="documentreference"/> <publisher value="FHIR Project"/> <description value="Basic Profile. A reference to a document."/> <status value="draft"/> <date value="2014-01-31"/> <structure> <type value="DocumentReference"/> <publish value="true"/> <element> <path value="DocumentReference"/> <definition> <short value="A reference to a document"/> <formal value="A reference to a document."/> <comments value="Usually, this is used for documents other than those defined by FHIR."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <constraint> <key value="1"/> <name value="Location"/> <severity value="error"/> <human value="A location or a service (or both) must be provided"/> <xpath value="exists(f:location) or exists(f:service)"/> </constraint> <isModifier value="false"/> <mapping> <target value="http://ihe.net/xds"/> <map value="XDS Metadata"/> </mapping> </definition> </element> <element> <path value="DocumentReference.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal 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 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 must be met as part of the definition of the extension."/> <comments 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 simplicity for everyone."/> <synonym value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal 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."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.contained"/> <definition> <short value="Contained, inline Resources"/> <formal 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."/> <comments 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."/> <synonym value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.masterIdentifier"/> <definition> <short value="Master Version Specific Identifier"/> <formal 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."/> <min value="1"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-12-Unique Document Number"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="External ID: 2e82c1f6-a085-4c72-9da3-8640a32e42ab"/> </mapping> </definition> </element> <element> <path value="DocumentReference.identifier"/> <definition> <short value="Other identifiers for the document"/> <formal value="Other identifiers associated with the record."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-16-Unique Document File Name?"/> </mapping> </definition> </element> <element> <path value="DocumentReference.subject"/> <definition> <short value="The subject of the document"/> <formal value="Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. 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"/> <type> <code value="Resource(Patient|Practitioner|Group|Device)"/> </type> <isModifier value="false"/> <mapping> <target value="http://hl7.org/v2"/> <map value="PID-3-Patient ID List (No standard way to define a Practitioner or Group subject in V2 MDM message)"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="Slot : sourcePatientId + Slot : sourcePatientInfo"/> </mapping> </definition> </element> <element> <path value="DocumentReference.type"/> <definition> <short value="What kind of document this is (LOINC if possible)"/> <formal value="Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)."/> <comments value="Key metadata element describing the document, used in searching/filtering."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding value="DocumentType"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-2-Document Type"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="Classification: 41a5887f-8865-4c09-adf7-e362475b143a (classCode)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.subtype"/> <definition> <short value="More detail about the document type"/> <formal value="More detailed information about the document type."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding value="DocumentSubType"/> <mapping> <target value="http://ihe.net/xds"/> <map value="Classification: aa543740-bdda-424e-8c96-df4873be8500 (typeCode)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.author"/> <definition> <short value="Who/what authored the document"/> <formal value="Identifies who is responsible for adding the information to the document."/> <comments value="Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant)."/> <min value="1"/> <max value="*"/> <type> <code value="Resource(Practitioner|Device)"/> </type> <isModifier value="false"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-9-Originator Code/Name (No standard way to indicate a Device in V2 MDM message)"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="Classification: 93606bcf-9494-43ec-9b4e-a7748d1a838d (author)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.custodian"/> <definition> <short value="Org which maintains the document"/> <formal value="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document."/> <comments value="Identifies where to go to find the current version, where to report issues, etc."/> <min value="0"/> <max value="1"/> <type> <code value="Resource(Organization)"/> </type> <isModifier value="false"/> <mapping> <target value="http://ihe.net/xds"/> <map value="n/a"/> </mapping> </definition> </element> <element> <path value="DocumentReference.authenticator"/> <definition> <short value="Who authenticated the document"/> <formal value="Which person or organization authenticates that this document is valid."/> <min value="0"/> <max value="1"/> <type> <code value="Resource(Practitioner|Organization)"/> </type> <isModifier value="false"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-10-Assigned Document Authenticator"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="?"/> </mapping> </definition> </element> <element> <path value="DocumentReference.created"/> <definition> <short value="Document creation time"/> <formal value="When the document was created."/> <comments 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"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-6-Origination Date/Time"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="Slot : creationTime"/> </mapping> </definition> </element> <element> <path value="DocumentReference.indexed"/> <definition> <short value="When this document reference created"/> <formal value="When the document reference was created."/> <comments value="Referencing/indexing time is used for tracking, organizing versions and searching."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isModifier value="false"/> <mapping> <target value="http://ihe.net/xds"/> <map value="Slot : creationTime"/> </mapping> </definition> </element> <element> <path value="DocumentReference.status"/> <definition> <short value="current | superseded | error"/> <formal value="The status of this document reference."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <binding value="DocumentReferenceStatus"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-19-Document Availability Status"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="implied by XDS workflow"/> </mapping> </definition> </element> <element> <path value="DocumentReference.docStatus"/> <definition> <short value="Status of the underlying document"/> <formal value="The status of the underlying document."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding value="ReferredDocumentStatus"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-17-Document Completion Status"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="n/a ?"/> </mapping> </definition> </element> <element> <path value="DocumentReference.supercedes"/> <definition> <short value="If this document replaces another"/> <formal value="If this document replaces another."/> <min value="0"/> <max value="1"/> <type> <code value="Resource(DocumentReference)"/> </type> <isModifier value="true"/> <mapping> <target value="http://ihe.net/xds"/> <map value="todo"/> </mapping> </definition> </element> <element> <path value="DocumentReference.description"/> <definition> <short value="Human Readable description (title)"/> <formal value="Human Readable description of the source document. This is sometimes known as the "title"."/> <comments value="What the document is about, rather than a terse summary of the document. It's 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")."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-25-Document Title"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="ExtrinsicObject/Name"/> </mapping> </definition> </element> <element> <path value="DocumentReference.confidentiality"/> <definition> <short value="Sensitivity of source document"/> <formal value="A code specifying the level of confidentiality of the XDS Document."/> <comments value="The interpretation of this field, and more generally enforcement and issues related to highly sensitive documents are beyond the scope of this resource. confidentialityCode can only be understood in the context of the policies, procedures, and value set specified by the context in which the document reference is being used."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="true"/> <binding value="DocumentConfidentiality"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-18-Document Confidentiality Status"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="Classification: f4f85eac-e6cb-4883-b524-f2705394840f (confidentialityCode)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.primaryLanguage"/> <definition> <short value="Primary language of the document"/> <formal value="The primary language in which the source document is written."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding value="Language"/> <mapping> <target value="http://ihe.net/xds"/> <map value="Slot : languageCode"/> </mapping> </definition> </element> <element> <path value="DocumentReference.mimeType"/> <definition> <short value="Mime type of the document"/> <formal value="The mime type of the source document."/> <comments value="Note: application/hl7-v3+xml for CDA. application/binary for proprietary record formats."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding value="MimeType"/> <mapping> <target value="http://hl7.org/v2"/> <map value="TXA-3-Document Content Presentation"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="ExtrinsicObject/@mimeType"/> </mapping> </definition> </element> <element> <path value="DocumentReference.format"/> <definition> <short value="Format of the document"/> <formal value="The format of the document. This is used when the mimeType of the document does not provide enough differentiating information (typically, when the mime type of the document is text/xml)."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding value="DocumentFormat"/> <mapping> <target value="http://ihe.net/xds"/> <map value="Classification: a09d5840-386c-46f2-b5ad-9c3699a4309d (formatCode)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.size"/> <definition> <short value="Size of the document in bytes"/> <formal value="The size of the source document this reference refers to in bytes."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> <mapping> <target value="http://ihe.net/xds"/> <map value="Slot : size"/> </mapping> </definition> </element> <element> <path value="DocumentReference.hash"/> <definition> <short value="HexBinary representation of SHA1"/> <formal value="A hash of the source document to ensure that changes have not occurred."/> <comments value="Whether the hash must be present and/or correct depends on the document handling rules defined in the context of use."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> <mapping> <target value="http://ihe.net/xds"/> <map value="Slot : hash"/> </mapping> </definition> </element> <element> <path value="DocumentReference.location"/> <definition> <short value="Where to access the document"/> <formal value="A url at which the document can be accessed."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="false"/> <mapping> <target value="http://hl7.org/v2"/> <map value="(Might include V2 TXA-16-Unique Document File Name or TXA-24-Folder Assignment)"/> </mapping> <mapping> <target value="http://ihe.net/xds"/> <map value="repository location (by implication & configuration)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.service"/> <definition> <short value="If access is not fully described by location"/> <formal value="A description of a service call that can be used to retrieve the document."/> <comments value="If a document can be accessed by either a service or directly by a URL (i.e. an XDS repository with an MHD access point, or a DICOM network with a WADO portal) just provide the URL."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <target value="http://ihe.net/xds"/> <map value="determined from repository location + parameters"/> </mapping> </definition> </element> <element> <path value="DocumentReference.service.type"/> <definition> <short value="Type of service (i.e. XDS.b)"/> <formal value="The type of the service that can be used to access the documents."/> <comments value="The meaning and interpretation of the parameters depends on the service type."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding value="DocumentServiceType"/> </definition> </element> <element> <path value="DocumentReference.service.address"/> <definition> <short value="Where service is located (usually a URL)"/> <formal value="Where the service end-point is located."/> <comments value="Usually this is a URL, but for some services, the end-point is a simple network name or address that is not a valid URL."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.service.parameter"/> <definition> <short value="Service call parameters"/> <formal value="A list of named parameters that is used in the service call."/> <comments value="The interpretation of the parameters, and how to convert them into a proper service call, is dependent on the type of the service, and needs to be specified in an implementation guide somewhere."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.service.parameter.name"/> <definition> <short value="Name of parameter"/> <formal value="The name of a parameter."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.service.parameter.value"/> <definition> <short value="Parameter value"/> <formal value="The value of the named parameter."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="DocumentReference.context"/> <definition> <short value="Clinical context of document"/> <formal value="The clinical context in which the document was prepared."/> <comments value="These values are primarily added to help with searching for interesting/relevant documents."/> <min value="0"/> <max value="1"/> <isModifier value="false"/> <mapping> <target value="http://ihe.net/xds"/> <map value="(if needed)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.context.code"/> <definition> <short value="Type of context (i.e. type of event)"/> <formal value="The type of clinical context, such as a kind of surgery, or a kind of speciality, or a clinical type."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding value="DocumentEventCode"/> <mapping> <target value="http://ihe.net/xds"/> <map value="Classification : cccf5598-8b07-4b77-a05e-ae952c785ead (practice setting)"/> </mapping> </definition> </element> <element> <path value="DocumentReference.context.period"/> <definition> <short value="Time described by the document"/> <formal value="The time period of the patient's care that is described by the document."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> <isModifier value="false"/> <mapping> <target value="http://ihe.net/xds"/> <map value="Slot : serviceStartTime & Slot : serviceStopTime"/> </mapping> </definition> </element> <element> <path value="DocumentReference.context.facilityType"/> <definition> <short value="Kind of facility where patient was seen"/> <formal value="The kind of facility where the patient was seen."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding value="DocumentFacilityType"/> <mapping> <target value="http://ihe.net/xds"/> <map value="Classification : f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1 (healthcare Facility Type)"/> </mapping> </definition> </element> </structure> <binding> <name value="DocumentSubType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <type value="ValueSet"/> <reference value="http://hl7.org/fhir/vs/xds-typecodes"/> </referenceResource> </binding> <binding> <name value="DocumentEventCode"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <type value="ValueSet"/> <reference value="http://hl7.org/fhir/vs/doc-event-code"/> </referenceResource> </binding> <binding> <name value="DocumentConfidentiality"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <type value="ValueSet"/> <reference value="http://hl7.org/fhir/vs/doc-confidentiality"/> </referenceResource> </binding> <binding> <name value="ReferredDocumentStatus"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <type value="ValueSet"/> <reference value="http://hl7.org/fhir/vs/document-status"/> </referenceResource> </binding> <binding> <name value="MimeType"/> <conformance value="required"/> <referenceUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/> </binding> <binding> <name value="DocumentFormat"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <type value="ValueSet"/> <reference value="http://hl7.org/fhir/vs/xds-formatcodes"/> </referenceResource> </binding> <binding> <name value="Language"/> <conformance value="required"/> <referenceUri value="http://tools.ietf.org/html/bcp47"/> </binding> <binding> <name value="DocumentType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <type value="ValueSet"/> <reference value="http://hl7.org/fhir/vs/doc-codes"/> </referenceResource> </binding> <binding> <name value="DocumentFacilityType"/> <isExtensible value="true"/> <conformance value="example"/> <referenceResource> <type value="ValueSet"/> <reference value="http://hl7.org/fhir/vs/xds-facilitycodes"/> </referenceResource> </binding> <binding> <name value="DocumentServiceType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceResource> <type value="ValueSet"/> <reference value="http://hl7.org/fhir/vs/documentreference-service-types"/> </referenceResource> </binding> <binding> <name value="DocumentReferenceStatus"/> <conformance value="required"/> <referenceResource> <type value="ValueSet"/> <reference value="http://hl7.org/fhir/vs/document-reference-status"/> </referenceResource> </binding> </Profile>