Medicolegal Death Investigation (MDI) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-mdi-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/mdi/StructureDefinition/DocumentReference-mdi-report | Version: 3.0.0-draft | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: DocumentReferenceMDIReport | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.11.42.8 |
A reference to a death investigation document, such as an Autopsy Report or Investigator’s Narrative. The content may be included as inline base64 encoded data or be provided by direct reference (e.g., URL). The document type is required and is constrained by US Core to a LOINC value whose SCALE is DOC in the LOINC database or is the HL7 v3 Code System NullFlavor concept ‘unknown’.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile | A reference to a document | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | If LOINC code for type is not available, use HL7 v3 Code System NullFlavor (http://terminology.hl7.org/CodeSystem/v3-NullFlavor) code=UNK, display=unknown 'unknown'. Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
| ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Reference a terminology (code system & code) or use text to describe the document category. A category is required, so if none is available use NullFlavor Other code and describe category in text Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | If no system/code is available, use NullFLavor Other code, and describe the document category in text | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of document Binding: US Core DocumentReference Category (required): The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: us-core-6 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Encounter Profile) | Context of the document content | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | ||||
DocumentReference.type | required | USCoreDocumentReferenceTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
| ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.category:us-core | required | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category | ||||
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
DocumentReference.content.format | extensible | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
This structure is derived from USCoreDocumentReferenceProfile
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile | A reference to a document | |
![]() ![]() ![]() |
1..1 | CodeableConcept | If LOINC code for type is not available, use HL7 v3 Code System NullFlavor (http://terminology.hl7.org/CodeSystem/v3-NullFlavor) code=UNK, display=unknown 'unknown'. | |
![]() ![]() ![]() |
1..* | CodeableConcept | Reference a terminology (code system & code) or use text to describe the document category. A category is required, so if none is available use NullFlavor Other code and describe category in text | |
![]() ![]() ![]() ![]() |
0..1 | string | If no system/code is available, use NullFLavor Other code, and describe the document category in text | |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile | A reference to a document | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | If LOINC code for type is not available, use HL7 v3 Code System NullFlavor (http://terminology.hl7.org/CodeSystem/v3-NullFlavor) code=UNK, display=unknown 'unknown'. Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
| ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Reference a terminology (code system & code) or use text to describe the document category. A category is required, so if none is available use NullFlavor Other code and describe category in text Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | If no system/code is available, use NullFLavor Other code, and describe the document category in text | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of document Binding: US Core DocumentReference Category (required): The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: us-core-6 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Encounter Profile) | Context of the document content | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard | ||||
DocumentReference.type | required | USCoreDocumentReferenceTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
| ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.category:us-core | required | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.content.format | extensible | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
This structure is derived from USCoreDocumentReferenceProfile
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile | A reference to a document | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | If LOINC code for type is not available, use HL7 v3 Code System NullFlavor (http://terminology.hl7.org/CodeSystem/v3-NullFlavor) code=UNK, display=unknown 'unknown'. Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
| ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Reference a terminology (code system & code) or use text to describe the document category. A category is required, so if none is available use NullFlavor Other code and describe category in text Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | If no system/code is available, use NullFLavor Other code, and describe the document category in text | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of document Binding: US Core DocumentReference Category (required): The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: us-core-6 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Encounter Profile) | Context of the document content | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | ||||
DocumentReference.type | required | USCoreDocumentReferenceTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
| ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.category:us-core | required | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category | ||||
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
DocumentReference.content.format | extensible | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
Differential View
This structure is derived from USCoreDocumentReferenceProfile
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile | A reference to a document | |
![]() ![]() ![]() |
1..1 | CodeableConcept | If LOINC code for type is not available, use HL7 v3 Code System NullFlavor (http://terminology.hl7.org/CodeSystem/v3-NullFlavor) code=UNK, display=unknown 'unknown'. | |
![]() ![]() ![]() |
1..* | CodeableConcept | Reference a terminology (code system & code) or use text to describe the document category. A category is required, so if none is available use NullFlavor Other code and describe category in text | |
![]() ![]() ![]() ![]() |
0..1 | string | If no system/code is available, use NullFLavor Other code, and describe the document category in text | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile | A reference to a document | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | If LOINC code for type is not available, use HL7 v3 Code System NullFlavor (http://terminology.hl7.org/CodeSystem/v3-NullFlavor) code=UNK, display=unknown 'unknown'. Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
| ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Reference a terminology (code system & code) or use text to describe the document category. A category is required, so if none is available use NullFlavor Other code and describe category in text Slice: Unordered, Open by pattern:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | If no system/code is available, use NullFLavor Other code, and describe the document category in text | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of document Binding: US Core DocumentReference Category (required): The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: us-core-6 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Encounter Profile) | Context of the document content | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard | ||||
DocumentReference.type | required | USCoreDocumentReferenceTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
| ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.category:us-core | required | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.content.format | extensible | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
This structure is derived from USCoreDocumentReferenceProfile
Other representations of profile: CSV, Excel, Schematron