The formal definitions for the elements in the document resource. Also available as an XML file.
| Document |
| Definition | A documentation of healthcare-related information that is assembled together into a single statement of meaning that establishes its own context. A document is composed of a set of resources that include both human and computer readable portions. A human may attest to the accuracy of the human readable portion, and may authenticate and/or sign the entire whole. A document may be kept as a set of logically linked resources, or they may be bundled together in an atom feed |
| Control | 1..1 |
| Requirements | For document based framework |
| Comments | While the focus of this specification is on patient-specific clinical documents, this resource can also apply to other healthcare-related documents such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical |
| RIM Mapping | Document[classCode="DOC" and moodCode="EVN" and isNormalAct()] |
| To Do | Confidentiality? Language? Consent? Signatures |
| Document.information |
| Definition | Defines the medata and context for this document |
| Control | 1..1 |
| Type | DocumentInformation |
| Must Understand | true |
| Document.information.id |
| Definition | Logical Identifier for the document, assigned when created. This identifier stays constant when subsequent versions of the document are created |
| Control | 0..1 |
| Type | Identifier |
| Must Understand | true |
| Comments | see discussion in resource definition for how these relate |
| RIM Mapping | Document.id / Document.setId |
| Document.information.versionId |
| Definition | Version specific identifier for the document, assigned when created. This identifier changes when subsequent versions of the document are created |
| Control | 0..1 |
| Type | Identifier |
| Must Understand | true |
| Comments | see discussion in resource definition for how these relate |
| RIM Mapping | Document.id |
| Document.information.instant |
| Definition | the document creation time, when the document first came into being. Where the document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. |
| Control | 1..1 |
| Type | instant |
| Must Understand | true |
| Requirements | Creation time is used for tracking, organizing versions and searching. |
| RIM Mapping | ./effectiveTime[type="TS"] |
| Document.information.class |
| Definition | The code specifying the particular kind of document (e.g., Prescription, Discharge Summary, Report). |
| Control | 0..1 |
| Type | Coding |
| Comments | It is suggested that the XDS Affinity Domain draws these values from a coding scheme providing a coarse level of granularity (about 10 to 100 entries). Shall have a single value. This should be an extension |
| Document.information.type |
| Definition | Specifies the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note) |
| Control | 1..1 |
| Type | CodeableConcept from DocumentType |
| Must Understand | true |
| Requirements | Key metadata element describing the document, used in searching/filtering. |
| RIM Mapping | ./code |
| Document.information.title |
| Definition | Official human-readable label for the document |
| Control | 0..1 |
| Type | string |
| Requirements | Helps humans to assess whether the document is of interest |
| Comments | It's commonly the case that clinical documents do not have a title and are collectively referred to by the display name of Document.type (e.g. a "consultation" or "progress note"). Where these display names are rendered to the clinician or where the document has a unique title, the Document.title value should be used |
| RIM Mapping | ./title |
| Document.information.confidentialityCode |
| Definition | The code specifying the level of confidentiality of the XDS Document. These codes are specific to an XDS Affinity Domain. |
| Control | 1..1 |
| Type | Coding |
| Comments | Enforcement and issues related to highly sensitive documents are beyond the scope of XDS (see security section). confidentialityCode is part of a codification scheme and value set enforced by the Document Registry. |
| Document.information.subject |
| Definition | Identifies the primary subject of the document. |
| Control | 1..1 |
| Type | Resource(Person|Patient|Group|Device) |
| Must Understand | true |
| Requirements | Essential metadata for searching for the document, identifies who the document applies to |
| Comments | For clinical documents, this is usually the patient. |
| RIM Mapping | unique(./participation[typeCode="SBJ" and isNormalParticipation]/role[typeCode="PAT"])
or
unique(./participation[typeCode="SBJ" and isNormalParticipation]/role[typeCode="IDENT"]/player[determinerCode="INST" and classCode=("DEV", "ORG") and isNormalEntity()]) |
| To Do | Need to extend this to support documents with other types of subjects. Also rationalize with encounter & context elements |
| Document.information.author |
| Definition | Identifies who is responsible for the information in the document. (Not necessarily who typed it in.) |
| Control | 1..* |
| Type | Resource(Person|Agent) |
| Requirements | Identifies who is responsible for the content. |
| RIM Mapping | ./participation[typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()] |
| Document.information.attester |
| Definition | A participant who has attested to the accuracy of the document |
| Control | 0..* |
| Requirements | Identifies responsibility for the accuracy of the document content. |
| RIM Mapping | ./participation[typeCode="AUTHEN" and isNormalParticipation] |
| Document.information.attester.mode |
| Definition | The type of attestation the authenticator offers |
| Control | 1..1 |
| Type | code from DocumentAttestationMode |
| Requirements | Indicates the level of officialness of the attestation. |
| RIM Mapping | unique(./modeCode) |
| Document.information.attester.time |
| Definition | When document was attested by the party |
| Control | 0..1 |
| Type | dateTime |
| Requirements | Identifies when the information in the document was deemed accurate. (Things may have changed since then.) |
| RIM Mapping | ./time[type="TS" and isNormalDatatype()] |
| Document.information.attester.party |
| Definition | Who attested the document in the specified way |
| Control | 0..1 |
| Type | Resource(Person|Agent|Organization) |
| Requirements | Identifies who has taken on the responsibility for accuracy of the document content. |
| RIM Mapping | ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()]
or
./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()] |
| Document.information.custodian |
| Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. |
| Control | 0..1 |
| Type | Resource(Organization) |
| Requirements | Identifies where to go to find the current version, where to report issues, etc. |
| RIM Mapping | ./participation[typeCode="RCV" and isNormalParticipation]/role[classCode="CUST" and isNormalRole and not (player)]/scoper[classCode="ORG" and determinerCode="INST" and isNormalEntity()] |
| Document.information.event |
| Definition | The main event/act/item, such as a colonoscopy or an appendectomy, being documented |
| Control | 0..1 |
| Requirements | Provides context for the document and creates a linkage between a resource describing an event and the document created describing the event. |
| Comments | The event needs to be consistent with the type element, though can provide further information if desired |
| RIM Mapping | unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and isNormalAct]) |
| Document.information.event.code |
| 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. |
| Control | 0..* |
| Type | CodeableConcept |
| Comments | An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they shall not conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as “key words” for certain types of queries. |
| Document.information.event.period |
| Definition | The period of time covered by the document. There is no assertion that the document is a complete representation for this period, only that it documents events during this time |
| Control | 0..1 |
| Type | Period |
| Document.information.event.detail |
| Definition | Full details for the event(s) the document concents |
| Control | 0..* |
| Type | Resource(Any) |
| Document.information.encounter |
| Definition | Describes the clinical encounter or type of care this document is associated with. |
| Control | 0..1 |
| Type | Resource(Admission|InterestOfCare) |
| Requirements | Provides context for the document and supports searching. |
| RIM Mapping | unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct]) |
| Document.information.facilityType |
| Definition | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred |
| Control | 0..1 |
| Type | CodeableConcept |
| Comments | In some cases, the setting of the encounter is inherent in the typeCode, such as "Diabetes Clinic Progress Note". healthcareFacilityTypeCode shall be equivalent to or further specialize the value inherent in the typeCode; for example, where the typeCode is simply "Clinic Progress Note" and the value of healthcareFacilityTypeCode is "private clinic". The value shall not conflict with the value inherent in the typeCode, as such a conflict would create an ambiguous situation |
| Document.information.practiceSetting |
| Definition | The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology). |
| Control | 0..1 |
| Type | CodeableConcept |
| Comments | It is suggested that the XDS Affinity Domain draws these values from a coding scheme providing a coarse level of granularity (about 10 to 100 entries) |
| Document.replaces |
| Definition | Identifies the document this document supersedes, if any. |
| Control | 0..1 |
| Type | id |
| Must Understand | true |
| Requirements | Used to establish relationships between documents to determine which is the most current/authoritative. |
| RIM Mapping | unique(highest(./outboundRelationship[typeCode="RPLC and isNormalActRelationship()], priorityNumber)/target[classCode="DOC" and moodCode="EVN" and isNormalAct]/id[isNormalDatatype() and displayable="false" and scope="OBJ" and reliability="ISS"]) |
| Document.provenance |
| Definition | Additional provenance about the document and the resources that are the sections |
| Control | 0..* |
| Type | Resource(Provenance) |
| Must Understand | true |
| Document.stylesheet |
| Definition | A fixed stylesheet to use when rendering the documents |
| Control | 0..1 |
| Type | Attachment |
| RIM Mapping | N/A |
| Document.representation |
| Definition | An alternative representation of the document that can be used in place of the html based rendering |
| Control | 0..1 |
| Type | Attachment |
| Requirements | Support for CDA level 1 |
| Comments | Typically, this is application/pdf |
| Document.section |
| Definition | Identifies a main topic within the document's table of contents |
| Control | 0..* |
| Requirements | Adds organization and human navigability to the information in the document. |
| RIM Mapping | ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct] |
| Document.section.code |
| Definition | A code identifying the kind of content contained within the section |
| Control | 0..1 |
| Type | CodeableConcept from DocumentSectionCode |
| Requirements | Provides computable standardized labels to topics within the document. |
| RIM Mapping | ./code |
| Document.section.subject |
| Definition | Identifies the primary subject of the section. |
| Control | 0..1 |
| Type | Resource(Patient|Group|Device) |
| Must Understand | true |
| Requirements | Subjects can vary, for example mother/baby, patient & relatives, etc. |
| RIM Mapping | unique(./participation[typeCode="SBJ" and isNormalParticipation]/role[typeCode="PAT"])
or
unique(./participation[typeCode="SBJ" and isNormalParticipation]/role[typeCode="IDENT"]/player[determinerCode="INST" and classCode=("DEV", "ORG") and isNormalEntity()]) |
| Document.section.content |
| Definition | Identifies the discrete data that provides the content for the section. |
| Control | 0..1 |
| Type | Resource(Any) |
| Must Understand | true |
| Requirements | Conveys the discrete data associated with the document. |
| Comments | Because documents represent point-in-time snapshots, resource references should generally be to a specific version. |
| RIM Mapping | unique(./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode!="DOCSECT" and isNormalAct]) |
| To Do | This may need to be 0..*. May need to consider adding text here to to account for missing resources. |
| Document.section.section |
| Definition | Identifies a subtopic within the section as part of the document's table of contents |
| Control | 0..* |
| Type | @Document.Section |
| Requirements | Allows more complex document structures |
| RIM Mapping | ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct] |
| Document.extension |
| Definition | See Extensions |
| Control | 0..* |
| Type | Extension |
| RIM Mapping | N/A |
| Document.text |
| Definition | |
| Control | 1..1 |
| Type | Narrative |
| Must Understand | true |
| RIM Mapping | ./text[mimeType="text/plain"] |
This is an old version of FHIR retained for archive purposes. Do not use for anything else