This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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", "id": "DocumentReference", "meta": { "lastUpdated": "2015-02-23T09:07:27.665+11:00" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "url": "http://hl7.org/fhir/Profile/DocumentReference", "name": "DocumentReference", "publisher": "HL7 FHIR Project (FHIR Management Group)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm" } ] } ], "description": "Base Profile for DocumentReference Resource", "status": "draft", "date": "2015-02-23T09:07:27+11:00", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" }, { "identity": "xds", "uri": "http://ihe.net/xds", "name": "XDS" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2" } ], "type": "DocumentReference", "snapshot": { "element": [ { "path": "DocumentReference", "short": "A reference to a document", "definition": "A reference to a document.", "comments": "Usually, this is used for documents other than those defined by FHIR.", "min": 1, "max": "1", "mapping": [ { "identity": "rim", "map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]" } ] }, { "path": "DocumentReference.id", "short": "Logical id of this artefact", "definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.", "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.", "min": 0, "max": "1", "type": [ { "code": "id" } ] }, { "path": "DocumentReference.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "type": [ { "code": "Meta" } ] }, { "path": "DocumentReference.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": true }, { "path": "DocumentReference.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "name": "Language", "isExtensible": false, "conformance": "required", "description": "A human language", "referenceUri": "http://tools.ietf.org/html/bcp47" } }, { "path": "DocumentReference.text", "short": "Text summary of the resource, for human interpretation", "definition": "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" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "path": "DocumentReference.contained", "short": "Contained, inline Resources", "definition": "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" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "DocumentReference.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "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 level of simplicity for everyone.", "synonym": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "DocumentReference.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "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 level of simplicity for everyone.", "synonym": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "DocumentReference.masterIdentifier", "short": "Master Version Specific Identifier", "definition": "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.", "comments": "CDA Document Id extension and root.", "requirements": "The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g., for a DICOM standard document a 64 character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form oid^extension, where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.uniqueId" }, { "identity": "v2", "map": "TXA-12-Unique Document Number" }, { "identity": "rim", "map": ".id" } ] }, { "path": "DocumentReference.identifier", "short": "Other identifiers for the document", "definition": "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" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.entryUUID" }, { "identity": "v2", "map": "TXA-16-Unique Document File Name?" }, { "identity": "rim", "map": ".id / .setId" } ] }, { "path": "DocumentReference.subject", "short": "Who|what is the subject of the document", "definition": "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": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Group" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Device" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.patientId\nDocumentEntry.sourcePatientId\nDocumentEntry.SourcePatientInfo" }, { "identity": "v2", "map": "PID-3-Patient ID List (No standard way to define a Practitioner or Group subject in V2 MDM message)" }, { "identity": "rim", "map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" } ] }, { "path": "DocumentReference.type", "short": "Precice type of document", "definition": "The type code specifies the precise type of document from the user perspective. It is recommended that the value Set be drawn from a coding scheme providing a fine level of granularity such as LOINC. (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" } ], "binding": { "name": "DocumentType", "isExtensible": true, "conformance": "preferred", "description": "Type of a composition", "referenceReference": { "reference": "http://hl7.org/fhir/vs/doc-codes" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.type" }, { "identity": "v2", "map": "TXA-2-Document Type" }, { "identity": "rim", "map": "./code" } ] }, { "path": "DocumentReference.class", "short": "High-level classification of document", "definition": "The class code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).", "comments": "Helps humans to assess whether the document is of interest when viewing an list of documents.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "name": "DocumentClass", "isExtensible": true, "conformance": "example", "description": "SubType of a clinical document", "referenceReference": { "reference": "http://hl7.org/fhir/vs/xds-typecodes" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.class" }, { "identity": "v2", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ] }, { "path": "DocumentReference.format", "short": "Format/content rules for the document", "definition": "An identifier that identifies the the document encoding, structure and template that the document conforms to beyond the base format indicated in the mimeType.", "comments": "Helps the processing. Usually is a URN that identifies. For IHE defined Document Content profiles this is a urn issued by IHE.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.formatCode" }, { "identity": "rim", "map": "n/a" } ] }, { "path": "DocumentReference.author", "short": "Who and/or what authored the document", "definition": "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": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Organization" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Device" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/RelatedPerson" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.author" }, { "identity": "v2", "map": "TXA-9-Originator Code/Name (No standard way to indicate a Device in V2 MDM message)" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" } ] }, { "path": "DocumentReference.custodian", "short": "Org which maintains the document", "definition": "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": "Reference", "profile": "http://hl7.org/fhir/Profile/Organization" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]" } ] }, { "path": "DocumentReference.policyManager", "short": "Manages access policies for the document", "definition": "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" } ], "mapping": [ { "identity": "rim", "map": "N/A - New participation type required" } ] }, { "path": "DocumentReference.authenticator", "short": "Who/What authenticated the document", "definition": "Which person or organization authenticates that this document is valid.", "comments": "Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Organization" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.legalAuthenticator" }, { "identity": "v2", "map": "TXA-10-Assigned Document Authenticator" }, { "identity": "rim", "map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]" } ] }, { "path": "DocumentReference.created", "short": "Document creation time", "definition": "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" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.submissionTime" }, { "identity": "v2", "map": "TXA-6-Origination Date/Time" }, { "identity": "rim", "map": ".effectiveTime[type=\"TS\"]" } ] }, { "path": "DocumentReference.indexed", "short": "When this document reference created", "definition": "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" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.submissionTime" }, { "identity": "rim", "map": ".availabilityTime[type=\"TS\"]" } ] }, { "path": "DocumentReference.status", "short": "current | superceded | entered-in-error", "definition": "The status of this document reference.", "comments": "This is the status of the DocumentReference object, which might be independent from the docStatus.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "binding": { "name": "DocumentReferenceStatus", "isExtensible": false, "conformance": "required", "description": "The status of the document reference", "referenceReference": { "reference": "http://hl7.org/fhir/vs/document-reference-status" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry status" }, { "identity": "v2", "map": "TXA-19-Document Availability Status" }, { "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\"" } ] }, { "path": "DocumentReference.docStatus", "short": "preliminary | final | appended | amended | entered-in-error", "definition": "The status of the underlying document.", "comments": "The document that is pointed to might be in various lifecycle states.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "name": "ReferredDocumentStatus", "isExtensible": true, "conformance": "preferred", "description": "Status of the underlying document", "referenceReference": { "reference": "http://hl7.org/fhir/vs/composition-status" } }, "mapping": [ { "identity": "v2", "map": "TXA-17-Document Completion Status" }, { "identity": "rim", "map": ".statusCode" } ] }, { "path": "DocumentReference.relatesTo", "short": "Relationships to other documents", "definition": "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.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "DocumentReference.relatesTo.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "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 level of simplicity for everyone.", "synonym": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "DocumentReference.relatesTo.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "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 level of simplicity for everyone.", "synonym": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "DocumentReference.relatesTo.code", "short": "replaces | transforms | signs | appends", "definition": "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" } ], "binding": { "name": "DocumentRelationshipType", "isExtensible": false, "conformance": "required", "description": "The type of relationship between documents", "referenceReference": { "reference": "http://hl7.org/fhir/vs/document-relationship-type" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry Associations type" }, { "identity": "rim", "map": ".outboundRelationship.typeCode" } ] }, { "path": "DocumentReference.relatesTo.target", "short": "Target of the relationship", "definition": "The target document of this relationship.", "min": 1, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/DocumentReference" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry Associations reference" }, { "identity": "rim", "map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id" } ] }, { "path": "DocumentReference.description", "short": "Human-readable description (title)", "definition": "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\").", "requirements": "Helps humans to assess whether the document is of interest.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.description" }, { "identity": "v2", "map": "TXA-25-Document Title" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text" } ] }, { "path": "DocumentReference.confidentiality", "short": "Sensitivity of source document", "definition": "A set of Security-Tag codes specifying the level of privacy/security of the Document.", "comments": "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n• [1…1] Confidentiality Security Classification Label Field\n• [0…*] Sensitivity Security Category Label Field\n• [0…*] Compartment Security Category Label Field\n• [0…*] Integrity Security Category Label Field\n• [0…*] Handling Caveat Security Category Field\nIn the HL7 Healthcare Privacy and Security Classification System In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.", "requirements": "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isModifier": true, "binding": { "name": "DocumentConfidentiality", "isExtensible": true, "conformance": "preferred", "description": "Codes specifying the level of confidentiality of the composition", "referenceReference": { "reference": "http://hl7.org/fhir/v3/vs/Confidentiality" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.confidentialityCode" }, { "identity": "v2", "map": "TXA-18-Document Confidentiality Status" }, { "identity": "rim", "map": ".confidentialityCode" } ] }, { "path": "DocumentReference.content", "short": "Where to access the document", "definition": "The document or url to the document along with critical metadata to prove content has integrity.", "min": 1, "max": "*", "type": [ { "code": "Attachment" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.mimeType\nDocumentEntry.languageCode\nDocumentEntry.URI\nDocumentEntry.size\nDocumentEntry.hash\nDocumentEntry.title" } ] }, { "path": "DocumentReference.context", "short": "Clinical context of document", "definition": "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", "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']" } ] }, { "path": "DocumentReference.context.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "DocumentReference.context.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "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 level of simplicity for everyone.", "synonym": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "DocumentReference.context.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "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 level of simplicity for everyone.", "synonym": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "DocumentReference.context.event", "short": "Main Clinical Acts Documented", "definition": "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" } ], "binding": { "name": "DocumentEventType", "isExtensible": true, "conformance": "preferred", "description": "This list of codes represents the main clinical acts being documented", "referenceReference": { "reference": "http://hl7.org/fhir/v3/vs/ActCode" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.eventCodeList" }, { "identity": "rim", "map": ".code" } ] }, { "path": "DocumentReference.context.period", "short": "Time of service that is being documented", "definition": "The time period over which the service that is described by the document was provided.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.serviceStartTime\nDocumentEntry.serviceStopTime" }, { "identity": "rim", "map": ".effectiveTime" } ] }, { "path": "DocumentReference.context.facilityType", "short": "Kind of facility where patient was seen", "definition": "The kind of facility where the patient was seen.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "name": "DocumentFacilityType", "isExtensible": true, "conformance": "example", "description": "XDS Facility Type", "referenceReference": { "reference": "http://hl7.org/fhir/vs/xds-facilitycodes" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.healthcareFacilityTypeCode" }, { "identity": "rim", "map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" } ] } ] }, "differential": { "element": [ { "path": "DocumentReference", "short": "A reference to a document", "definition": "A reference to a document.", "comments": "Usually, this is used for documents other than those defined by FHIR.", "min": 1, "max": "1", "mapping": [ { "identity": "rim", "map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]" } ] }, { "path": "DocumentReference.masterIdentifier", "short": "Master Version Specific Identifier", "definition": "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.", "comments": "CDA Document Id extension and root.", "requirements": "The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g., for a DICOM standard document a 64 character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form oid^extension, where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.uniqueId" }, { "identity": "v2", "map": "TXA-12-Unique Document Number" }, { "identity": "rim", "map": ".id" } ] }, { "path": "DocumentReference.identifier", "short": "Other identifiers for the document", "definition": "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" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.entryUUID" }, { "identity": "v2", "map": "TXA-16-Unique Document File Name?" }, { "identity": "rim", "map": ".id / .setId" } ] }, { "path": "DocumentReference.subject", "short": "Who|what is the subject of the document", "definition": "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": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Group" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Device" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.patientId\nDocumentEntry.sourcePatientId\nDocumentEntry.SourcePatientInfo" }, { "identity": "v2", "map": "PID-3-Patient ID List (No standard way to define a Practitioner or Group subject in V2 MDM message)" }, { "identity": "rim", "map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" } ] }, { "path": "DocumentReference.type", "short": "Precice type of document", "definition": "The type code specifies the precise type of document from the user perspective. It is recommended that the value Set be drawn from a coding scheme providing a fine level of granularity such as LOINC. (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" } ], "binding": { "name": "DocumentType", "isExtensible": true, "conformance": "preferred", "description": "Type of a composition", "referenceReference": { "reference": "http://hl7.org/fhir/vs/doc-codes" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.type" }, { "identity": "v2", "map": "TXA-2-Document Type" }, { "identity": "rim", "map": "./code" } ] }, { "path": "DocumentReference.class", "short": "High-level classification of document", "definition": "The class code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).", "comments": "Helps humans to assess whether the document is of interest when viewing an list of documents.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "name": "DocumentClass", "isExtensible": true, "conformance": "example", "description": "SubType of a clinical document", "referenceReference": { "reference": "http://hl7.org/fhir/vs/xds-typecodes" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.class" }, { "identity": "v2", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ] }, { "path": "DocumentReference.format", "short": "Format/content rules for the document", "definition": "An identifier that identifies the the document encoding, structure and template that the document conforms to beyond the base format indicated in the mimeType.", "comments": "Helps the processing. Usually is a URN that identifies. For IHE defined Document Content profiles this is a urn issued by IHE.", "min": 0, "max": "*", "type": [ { "code": "uri" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.formatCode" }, { "identity": "rim", "map": "n/a" } ] }, { "path": "DocumentReference.author", "short": "Who and/or what authored the document", "definition": "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": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Organization" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Device" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/RelatedPerson" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.author" }, { "identity": "v2", "map": "TXA-9-Originator Code/Name (No standard way to indicate a Device in V2 MDM message)" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" } ] }, { "path": "DocumentReference.custodian", "short": "Org which maintains the document", "definition": "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": "Reference", "profile": "http://hl7.org/fhir/Profile/Organization" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]" } ] }, { "path": "DocumentReference.policyManager", "short": "Manages access policies for the document", "definition": "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" } ], "mapping": [ { "identity": "rim", "map": "N/A - New participation type required" } ] }, { "path": "DocumentReference.authenticator", "short": "Who/What authenticated the document", "definition": "Which person or organization authenticates that this document is valid.", "comments": "Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Organization" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.legalAuthenticator" }, { "identity": "v2", "map": "TXA-10-Assigned Document Authenticator" }, { "identity": "rim", "map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]" } ] }, { "path": "DocumentReference.created", "short": "Document creation time", "definition": "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" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.submissionTime" }, { "identity": "v2", "map": "TXA-6-Origination Date/Time" }, { "identity": "rim", "map": ".effectiveTime[type=\"TS\"]" } ] }, { "path": "DocumentReference.indexed", "short": "When this document reference created", "definition": "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" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.submissionTime" }, { "identity": "rim", "map": ".availabilityTime[type=\"TS\"]" } ] }, { "path": "DocumentReference.status", "short": "current | superceded | entered-in-error", "definition": "The status of this document reference.", "comments": "This is the status of the DocumentReference object, which might be independent from the docStatus.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "binding": { "name": "DocumentReferenceStatus", "isExtensible": false, "conformance": "required", "description": "The status of the document reference", "referenceReference": { "reference": "http://hl7.org/fhir/vs/document-reference-status" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry status" }, { "identity": "v2", "map": "TXA-19-Document Availability Status" }, { "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\"" } ] }, { "path": "DocumentReference.docStatus", "short": "preliminary | final | appended | amended | entered-in-error", "definition": "The status of the underlying document.", "comments": "The document that is pointed to might be in various lifecycle states.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "name": "ReferredDocumentStatus", "isExtensible": true, "conformance": "preferred", "description": "Status of the underlying document", "referenceReference": { "reference": "http://hl7.org/fhir/vs/composition-status" } }, "mapping": [ { "identity": "v2", "map": "TXA-17-Document Completion Status" }, { "identity": "rim", "map": ".statusCode" } ] }, { "path": "DocumentReference.relatesTo", "short": "Relationships to other documents", "definition": "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.code", "short": "replaces | transforms | signs | appends", "definition": "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" } ], "binding": { "name": "DocumentRelationshipType", "isExtensible": false, "conformance": "required", "description": "The type of relationship between documents", "referenceReference": { "reference": "http://hl7.org/fhir/vs/document-relationship-type" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry Associations type" }, { "identity": "rim", "map": ".outboundRelationship.typeCode" } ] }, { "path": "DocumentReference.relatesTo.target", "short": "Target of the relationship", "definition": "The target document of this relationship.", "min": 1, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/DocumentReference" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry Associations reference" }, { "identity": "rim", "map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id" } ] }, { "path": "DocumentReference.description", "short": "Human-readable description (title)", "definition": "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\").", "requirements": "Helps humans to assess whether the document is of interest.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.description" }, { "identity": "v2", "map": "TXA-25-Document Title" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text" } ] }, { "path": "DocumentReference.confidentiality", "short": "Sensitivity of source document", "definition": "A set of Security-Tag codes specifying the level of privacy/security of the Document.", "comments": "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n• [1…1] Confidentiality Security Classification Label Field\n• [0…*] Sensitivity Security Category Label Field\n• [0…*] Compartment Security Category Label Field\n• [0…*] Integrity Security Category Label Field\n• [0…*] Handling Caveat Security Category Field\nIn the HL7 Healthcare Privacy and Security Classification System In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.", "requirements": "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isModifier": true, "binding": { "name": "DocumentConfidentiality", "isExtensible": true, "conformance": "preferred", "description": "Codes specifying the level of confidentiality of the composition", "referenceReference": { "reference": "http://hl7.org/fhir/v3/vs/Confidentiality" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.confidentialityCode" }, { "identity": "v2", "map": "TXA-18-Document Confidentiality Status" }, { "identity": "rim", "map": ".confidentialityCode" } ] }, { "path": "DocumentReference.content", "short": "Where to access the document", "definition": "The document or url to the document along with critical metadata to prove content has integrity.", "min": 1, "max": "*", "type": [ { "code": "Attachment" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.mimeType\nDocumentEntry.languageCode\nDocumentEntry.URI\nDocumentEntry.size\nDocumentEntry.hash\nDocumentEntry.title" } ] }, { "path": "DocumentReference.context", "short": "Clinical context of document", "definition": "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", "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']" } ] }, { "path": "DocumentReference.context.event", "short": "Main Clinical Acts Documented", "definition": "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" } ], "binding": { "name": "DocumentEventType", "isExtensible": true, "conformance": "preferred", "description": "This list of codes represents the main clinical acts being documented", "referenceReference": { "reference": "http://hl7.org/fhir/v3/vs/ActCode" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.eventCodeList" }, { "identity": "rim", "map": ".code" } ] }, { "path": "DocumentReference.context.period", "short": "Time of service that is being documented", "definition": "The time period over which the service that is described by the document was provided.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "xds", "map": "DocumentEntry.serviceStartTime\nDocumentEntry.serviceStopTime" }, { "identity": "rim", "map": ".effectiveTime" } ] }, { "path": "DocumentReference.context.facilityType", "short": "Kind of facility where patient was seen", "definition": "The kind of facility where the patient was seen.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "name": "DocumentFacilityType", "isExtensible": true, "conformance": "example", "description": "XDS Facility Type", "referenceReference": { "reference": "http://hl7.org/fhir/vs/xds-facilitycodes" } }, "mapping": [ { "identity": "xds", "map": "DocumentEntry.healthcareFacilityTypeCode" }, { "identity": "rim", "map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" } ] } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.