. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A reference to a document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference\"><b>DocumentReference</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a 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.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.masterIdentifier\"><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.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Master Version Specific Identifier</span><span style=\"color: Gray\"> --></span></masterIdentifier>\r\n <<a title=\"Other identifiers associated with the document, including version independent, source record and workflow related identifiers.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Other identifiers for the document</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a 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).\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.subject\"><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.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Who|what is the subject of the document</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.).\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.type\"><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.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-codes.html\">What kind of document this is (LOINC if possible)</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.class\"><b>class</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-typecodes.html\">Categorization of Document</a></span><span style=\"color: Gray\"> --></span></class>\r\n <<a title=\"Identifies who is responsible for adding the information to the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.author\"><b>author</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">\r\n Who and/or what authored the document</span><span style=\"color: Gray\"> --></span></author>\r\n <<a title=\"Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.custodian\"><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.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">Org which maintains the document</span><span style=\"color: Gray\"> --></span></custodian>\r\n <<a title=\"A reference to a domain or server that manages policies under which the document is accessed and/or made available.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.policyManager\"><b>policyManager</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Manages access policies for the document</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Which person or organization authenticates that this document is valid.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.authenticator\"><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.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Who/What authenticated the document</span><span style=\"color: Gray\"> --></span></authenticator>\r\n <<a title=\"When the document was created.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.created\"><b>created</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#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>\r\n <<a title=\"When the document reference was created.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.indexed\"><b>indexed</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#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>\r\n <<a title=\"The status of this document reference (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-reference-status.html\">current | superceded | entered in error</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the underlying document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.docStatus\"><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.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"composition-status.html\">preliminary | final | appended | amended | entered in error</a><span style=\"color: Gray\"> --></span></docStatus>\r\n <<a title=\"Relationships that this document has with other document references that already exist (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.relatesTo\"><span style=\"text-decoration: underline\"><b>relatesTo</b></span></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Relationships to other documents --></span>\r\n <<a title=\"The type of relationship that this document has with anther document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.relatesTo.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-relationship-type.html\">replaces | transforms | signs | appends</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The target document of this relationship.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.relatesTo.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"documentreference.html#DocumentReference\">DocumentReference</a>)</span> <span style=\"color: navy\">Target of the relationship</span><span style=\"color: Gray\"> --></span></target>\r\n </relatesTo>\r\n <<a title=\"Human-readable description of the source document. This is sometimes known as the "title".\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#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>\r\n <<a title=\"A code specifying the level of confidentiality of the XDS Document (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/Confidentiality/index.html\">Sensitivity of source document</a><span style=\"color: Gray\"> --></span></confidentiality>\r\n <<a title=\"The primary language in which the source document is written.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.primaryLanguage\"><b>primaryLanguage</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.html\">The marked primary language for the document</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The mime type of the source document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.mimeType\"><b>mimeType</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.html\">Mime type, + maybe character encoding</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.format\"><b>format</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Format/content rules for the document</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The size of the source document this reference refers to in bytes.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.size\"><b>size</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#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>\r\n <<a title=\"A hash of the source document to ensure that changes have not occurred.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.hash\"><b>hash</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#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>\r\n <<a title=\"A url at which the document can be accessed.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.location\"><b>location</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: A location or a service (or both) SHALL be provided\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Where to access the document</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A description of a service call that can be used to retrieve the document.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service\"><b>service</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A location or a service (or both) SHALL be provided\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> If access is not fully described by location --></span>\r\n <<a title=\"The type of the service that can be used to access the documents.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.type\"><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.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-documentreference-service-types.html\">Type of service (i.e. XDS.b)</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Where the service end-point is located.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.address\"><b>address</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#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>\r\n <<a title=\"A list of named parameters that is used in the service call.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.parameter\"><b>parameter</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Service call parameters --></span>\r\n <<a title=\"The name of a parameter.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.parameter.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Parameter name in service call</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The value of the named parameter.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.service.parameter.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Parameter value for the name</span><span style=\"color: Gray\"> --></span>\r\n </parameter>\r\n </service>\r\n <<a title=\"The clinical context in which the document was prepared.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context\"><b>context</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Clinical context of document --></span>\r\n <<a title=\"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.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context.event\"><b>event</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/ActCode/index.html\">Main Clinical Acts Documented</a><span style=\"color: Gray\"> --></span></event>\r\n <<a title=\"The time period over which the service that is described by the document was provided.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context.period\"><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.html#Period\">Period</a></span> <span style=\"color: navy\">Time of service that is being documented</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"The kind of facility where the patient was seen.\" class=\"dict\" href=\"documentreference-definitions.html#DocumentReference.context.facilityType\"><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.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-facilitycodes.html\">Kind of facility where patient was seen</a></span><span style=\"color: Gray\"> --></span></facilityType>\r\n </context>\r\n</DocumentReference>\r\n</pre></div>"
},
"name": "documentreference",
"publisher": "FHIR Project",
"description": "Basic Profile. A reference to a document.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A document reference resource is used to describe a document that is made available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes its own context (e.g. what subject, author etc), can be displayed to the user, and has defined update management. The document resource can be used with any document format that has a recognized mime type, and that conforms to this definition. \r\n\r\nTypically, Document Reference Resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile), and are used to refer to: \r\n\r\n* CDA documents in FHIR systems\r\n* FHIR documents stored elsewhere (i.e. registry/repository following the XDS model)\r\n* PDF documents, and even digital records of faxes where sufficient information is available\r\n* Other kinds of documents, such as records of prescriptions.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "DocumentReference",
"publish": true,
"element": [
{
"path": "DocumentReference",
"definition": {
"short": "A reference to a document",
"formal": "A reference to a document.",
"comments": "Usually, this is used for documents other than those defined by FHIR.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "1",
"name": "Location",
"severity": "error",
"human": "A location or a service (or both) SHALL be provided",
"xpath": "exists(f:location) or exists(f:service)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]"
}
]
}
},
{
"path": "DocumentReference.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 SHALL be met as part of the definition of the extension.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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": "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": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.masterIdentifier",
"definition": {
"short": "Master Version Specific Identifier",
"formal": "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": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "v2",
"map": "TXA-12-Unique Document Number"
}
]
}
},
{
"path": "DocumentReference.identifier",
"definition": {
"short": "Other identifiers for the document",
"formal": "Other identifiers associated with the document, including version independent, source record and workflow related identifiers.",
"comments": "Other identifiers can also include Identifiers may be Accession Numbers, Order Numbers, Referral Request \nIdentifiers, XDS Workflow Instance Identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id / .setId"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
}
]
}
},
{
"path": "DocumentReference.subject",
"definition": {
"short": "Who|what is the subject of the document",
"formal": "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": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List (No standard way to define a Practitioner or Group subject in V2 MDM message)"
}
]
}
},
{
"path": "DocumentReference.type",
"definition": {
"short": "What kind of document this is (LOINC if possible)",
"formal": "Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.).",
"comments": "Key metadata element describing the document, used in searching/filtering.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/doc-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "v2",
"map": "TXA-2-Document Type"
}
]
}
},
{
"path": "DocumentReference.class",
"definition": {
"short": "Categorization of Document",
"formal": "A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type.",
"comments": "Helps humans to assess whether the document is of interest when viewing an index of documents.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentClass",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/xds-typecodes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
},
{
"identity": "v2",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
}
},
{
"path": "DocumentReference.author",
"definition": {
"short": "Who and/or what authored the document",
"formal": "Identifies who is responsible for adding the information to the document.",
"comments": "Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant).",
"min": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/RelatedPerson"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity": "v2",
"map": "TXA-9-Originator Code/Name (No standard way to indicate a Device in V2 MDM message)"
}
]
}
},
{
"path": "DocumentReference.custodian",
"definition": {
"short": "Org which maintains the document",
"formal": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]"
}
]
}
},
{
"path": "DocumentReference.policyManager",
"definition": {
"short": "Manages access policies for the document",
"formal": "A reference to a domain or server that manages policies under which the document is accessed and/or made available.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A - New participation type required"
}
]
}
},
{
"path": "DocumentReference.authenticator",
"definition": {
"short": "Who/What authenticated the document",
"formal": "Which person or organization authenticates that this document is valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity": "v2",
"map": "TXA-10-Assigned Document Authenticator"
}
]
}
},
{
"path": "DocumentReference.created",
"definition": {
"short": "Document creation time",
"formal": "When the document was created.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime[type=\"TS\"]"
},
{
"identity": "v2",
"map": "TXA-6-Origination Date/Time"
}
]
}
},
{
"path": "DocumentReference.indexed",
"definition": {
"short": "When this document reference created",
"formal": "When the document reference was created.",
"comments": "Referencing/indexing time is used for tracking, organizing versions and searching.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".availabilityTime[type=\"TS\"]"
}
]
}
},
{
"path": "DocumentReference.status",
"definition": {
"short": "current | superceded | entered in error",
"formal": "The status of this document reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DocumentReferenceStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/document-reference-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\";\n\nfinal: .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()]);\n\namended: .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\"];\n\nwithdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\""
},
{
"identity": "v2",
"map": "TXA-19-Document Availability Status"
}
]
}
},
{
"path": "DocumentReference.docStatus",
"definition": {
"short": "preliminary | final | appended | amended | entered in error",
"formal": "The status of the underlying document.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ReferredDocumentStatus",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/composition-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "v2",
"map": "TXA-17-Document Completion Status"
}
]
}
},
{
"path": "DocumentReference.relatesTo",
"definition": {
"short": "Relationships to other documents",
"formal": "Relationships that this document has with other document references that already exist.",
"min": 0,
"max": "*",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship"
}
]
}
},
{
"path": "DocumentReference.relatesTo.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 SHALL be met as part of the definition of the extension.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.relatesTo.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.relatesTo.code",
"definition": {
"short": "replaces | transforms | signs | appends",
"formal": "The type of relationship that this document has with anther document.",
"comments": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "DocumentRelationshipType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/document-relationship-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship.typeCode"
}
]
}
},
{
"path": "DocumentReference.relatesTo.target",
"definition": {
"short": "Target of the relationship",
"formal": "The target document of this relationship.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/DocumentReference"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id"
}
]
}
},
{
"path": "DocumentReference.description",
"definition": {
"short": "Human-readable description (title)",
"formal": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"comments": "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\").",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text"
},
{
"identity": "v2",
"map": "TXA-25-Document Title"
}
]
}
},
{
"path": "DocumentReference.confidentiality",
"definition": {
"short": "Sensitivity of source document",
"formal": "A code specifying the level of confidentiality of the XDS Document.",
"comments": "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": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "DocumentConfidentiality",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/Confidentiality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".confidentialityCode"
},
{
"identity": "v2",
"map": "TXA-18-Document Confidentiality Status"
}
]
}
},
{
"path": "DocumentReference.primaryLanguage",
"definition": {
"short": "The marked primary language for the document",
"formal": "The primary language in which the source document is written.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "Language",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "rim",
"map": ".languageCode"
}
]
}
},
{
"path": "DocumentReference.mimeType",
"definition": {
"short": "Mime type, + maybe character encoding",
"formal": "The mime type of the source document.",
"comments": "Note: application/hl7-v3+xml for CDA. application/binary for proprietary record formats.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "MimeType",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"mapping": [
{
"identity": "rim",
"map": ".text.mediaType"
},
{
"identity": "v2",
"map": "TXA-3-Document Content Presentation"
}
]
}
},
{
"path": "DocumentReference.format",
"definition": {
"short": "Format/content rules for the document",
"formal": "An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType.",
"comments": "Most often used when the mime-type is text/xml.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.size",
"definition": {
"short": "Size of the document in bytes",
"formal": "The size of the source document this reference refers to in bytes.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.length"
}
]
}
},
{
"path": "DocumentReference.hash",
"definition": {
"short": "HexBinary representation of SHA1",
"formal": "A hash of the source document to ensure that changes have not occurred.",
"comments": "Whether the hash must be present and/or correct depends on the document handling rules defined in the context of use.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.integrityCheck"
}
]
}
},
{
"path": "DocumentReference.location",
"definition": {
"short": "Where to access the document",
"formal": "A url at which the document can be accessed.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.reference"
},
{
"identity": "v2",
"map": "(Might include V2 TXA-16-Unique Document File Name or TXA-24-Folder Assignment)"
}
]
}
},
{
"path": "DocumentReference.service",
"definition": {
"short": "If access is not fully described by location",
"formal": "A description of a service call that can be used to retrieve the document.",
"comments": "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": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text.reference"
}
]
}
},
{
"path": "DocumentReference.service.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 SHALL be met as part of the definition of the extension.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.service.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.service.type",
"definition": {
"short": "Type of service (i.e. XDS.b)",
"formal": "The type of the service that can be used to access the documents.",
"comments": "The meaning and interpretation of the parameters depends on the service type.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentServiceType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/documentreference-service-types"
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.service.address",
"definition": {
"short": "Where service is located (usually a URL)",
"formal": "Where the service end-point is located.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.service.parameter",
"definition": {
"short": "Service call parameters",
"formal": "A list of named parameters that is used in the service call.",
"comments": "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": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.service.parameter.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 SHALL be met as part of the definition of the extension.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.service.parameter.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.service.parameter.name",
"definition": {
"short": "Parameter name in service call",
"formal": "The name of a parameter.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.service.parameter.value",
"definition": {
"short": "Parameter value for the name",
"formal": "The value of the named parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
},
{
"path": "DocumentReference.context",
"definition": {
"short": "Clinical context of document",
"formal": "The clinical context in which the document was prepared.",
"comments": "These values are primarily added to help with searching for interesting/relevant documents.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']"
}
]
}
},
{
"path": "DocumentReference.context.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 SHALL be met as part of the definition of the extension.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.context.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "DocumentReference.context.event",
"definition": {
"short": "Main Clinical Acts Documented",
"formal": "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.",
"comments": "An event can further specialize the act inherent in the type, such as \nwhere 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": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentEventType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ActCode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "DocumentReference.context.period",
"definition": {
"short": "Time of service that is being documented",
"formal": "The time period over which the service that is described by the document was provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
}
},
{
"path": "DocumentReference.context.facilityType",
"definition": {
"short": "Kind of facility where patient was seen",
"formal": "The kind of facility where the patient was seen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DocumentFacilityType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/xds-facilitycodes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "authenticator",
"type": "reference",
"documentation": "Who/What authenticated the document",
"xpath": "f:DocumentReference/f:authenticator"
},
{
"name": "author",
"type": "reference",
"documentation": "Who and/or what authored the document",
"xpath": "f:DocumentReference/f:author"
},
{
"name": "class",
"type": "token",
"documentation": "Categorization of Document",
"xpath": "f:DocumentReference/f:class"
},
{
"name": "confidentiality",
"type": "token",
"documentation": "Sensitivity of source document",
"xpath": "f:DocumentReference/f:confidentiality"
},
{
"name": "created",
"type": "date",
"documentation": "Document creation time",
"xpath": "f:DocumentReference/f:created"
},
{
"name": "custodian",
"type": "reference",
"documentation": "Org which maintains the document",
"xpath": "f:DocumentReference/f:custodian"
},
{
"name": "description",
"type": "string",
"documentation": "Human-readable description (title)",
"xpath": "f:DocumentReference/f:description"
},
{
"name": "event",
"type": "token",
"documentation": "Main Clinical Acts Documented",
"xpath": "f:DocumentReference/f:context/f:event"
},
{
"name": "facility",
"type": "token",
"documentation": "Kind of facility where patient was seen",
"xpath": "f:DocumentReference/f:context/f:facilityType"
},
{
"name": "format",
"type": "token",
"documentation": "Format/content rules for the document",
"xpath": "f:DocumentReference/f:format"
},
{
"name": "identifier",
"type": "token",
"documentation": "Master Version Specific Identifier"
},
{
"name": "indexed",
"type": "date",
"documentation": "When this document reference created",
"xpath": "f:DocumentReference/f:indexed"
},
{
"name": "language",
"type": "token",
"documentation": "The marked primary language for the document",
"xpath": "f:DocumentReference/f:primaryLanguage"
},
{
"name": "location",
"type": "string",
"documentation": "Where to access the document",
"xpath": "f:DocumentReference/f:location"
},
{
"name": "period",
"type": "date",
"documentation": "Time of service that is being documented",
"xpath": "f:DocumentReference/f:context/f:period"
},
{
"name": "relatesto",
"type": "reference",
"documentation": "Target of the relationship",
"xpath": "f:DocumentReference/f:relatesTo/f:target"
},
{
"name": "relation",
"type": "token",
"documentation": "replaces | transforms | signs | appends",
"xpath": "f:DocumentReference/f:relatesTo/f:code"
},
{
"name": "relationship",
"type": "composite",
"documentation": "Combination of relation and relatesTo"
},
{
"name": "size",
"type": "number",
"documentation": "Size of the document in bytes",
"xpath": "f:DocumentReference/f:size"
},
{
"name": "status",
"type": "token",
"documentation": "current | superceded | entered in error",
"xpath": "f:DocumentReference/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "Who|what is the subject of the document",
"xpath": "f:DocumentReference/f:subject"
},
{
"name": "type",
"type": "token",
"documentation": "What kind of document this is (LOINC if possible)",
"xpath": "f:DocumentReference/f:type"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change