CH LAB-Order (R4)
3.0.0-ci-build - ci-build
CH LAB-Order (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-lab-order/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-document-reference | Version: 3.0.0-ci-build | |||
Active as of 2025-10-15 | Computable Name: ChLabDocumentReference | |||
Copyright/Legal: CC0-1.0 |
Profile to describe how to provide a reference to a document to make it available to a healthcare system.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CHCoreDocumentReference | CH Core DocumentReference | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(CH Core Patient) | Who/what is the subject of the document |
![]() ![]() ![]() |
SΣ | 0..* | Reference(CH Core PractitionerRole) | Who and/or what authored the document |
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() |
SΣC | 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. Constraints: ch-docref-1 Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Related identifiers or resources |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.type | Base | preferred | DocumentEntry.typeCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.category | Base | preferred | DocumentEntry.classCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
ch-docref-1 | warning | DocumentReference.content.attachment.contentType | The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType |
memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
|
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()
|
This structure is derived from CHCoreDocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CHCoreDocumentReference | CH Core DocumentReference | |
![]() ![]() ![]() |
S | 1..1 | code | current | superseded | entered-in-error |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Precise type of clinical document |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | High-level kind of a clinical document at a macro level |
![]() ![]() ![]() |
S | 0..1 | Reference(CH Core Patient) | Who/what is the subject of the document |
![]() ![]() ![]() |
S | 0..* | Reference(CH Core PractitionerRole) | Who and/or what authored the document |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Related identifiers or resources |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CHCoreDocumentReference | CH Core DocumentReference | |||||
![]() ![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(CH Core Patient) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(CH Core PractitionerRole) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Who/what authenticated the document | |||||
![]() ![]() ![]() |
0..1 | Reference(CH Core 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(CH Core DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: DocumentEntry.confidentialityCode (extensible) | ||||
![]() ![]() ![]() |
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Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 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. Constraints: ch-docref-1 Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred) Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentEntry.formatCode (preferred) | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..* | Reference(CH Core Encounter | EpisodeOfCare) | 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. | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (preferred) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (preferred) | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(CH Core Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Related identifiers or resources | ||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.docStatus | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.type | Base | preferred | DocumentEntry.typeCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.category | Base | preferred | DocumentEntry.classCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
DocumentReference.securityLabel | Base | extensible | DocumentEntry.confidentialityCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
DocumentReference.content.attachment.language | Base | preferred | DocumentEntry.languageCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.content.format | Base | preferred | DocumentEntry.formatCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
DocumentReference.context.facilityType | Base | preferred | DocumentEntry.healthcareFacilityTypeCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.context.practiceSetting | Base | preferred | DocumentEntry.practiceSettingCode | 📦3.3.0-ci-build | CH Term v3.3 |
Id | Grade | Path(s) | Description | Expression |
ch-docref-1 | warning | DocumentReference.content.attachment.contentType | The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType |
memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
|
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()
|
This structure is derived from CHCoreDocumentReference
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CHCoreDocumentReference | CH Core DocumentReference | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(CH Core Patient) | Who/what is the subject of the document |
![]() ![]() ![]() |
SΣ | 0..* | Reference(CH Core PractitionerRole) | Who and/or what authored the document |
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() |
SΣC | 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. Constraints: ch-docref-1 Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Related identifiers or resources |
![]() |
Path | Status | Usage | ValueSet | Version | Source |
DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.type | Base | preferred | DocumentEntry.typeCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.category | Base | preferred | DocumentEntry.classCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
Id | Grade | Path(s) | Description | Expression |
ch-docref-1 | warning | DocumentReference.content.attachment.contentType | The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType |
memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
|
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()
|
Differential View
This structure is derived from CHCoreDocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CHCoreDocumentReference | CH Core DocumentReference | |
![]() ![]() ![]() |
S | 1..1 | code | current | superseded | entered-in-error |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Precise type of clinical document |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | High-level kind of a clinical document at a macro level |
![]() ![]() ![]() |
S | 0..1 | Reference(CH Core Patient) | Who/what is the subject of the document |
![]() ![]() ![]() |
S | 0..* | Reference(CH Core PractitionerRole) | Who and/or what authored the document |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
S | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Related identifiers or resources |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CHCoreDocumentReference | CH Core DocumentReference | |||||
![]() ![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Precise type of clinical document Binding: DocumentEntry.typeCode (preferred) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | High-level kind of a clinical document at a macro level Binding: DocumentEntry.classCode (preferred) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(CH Core Patient) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(CH Core PractitionerRole) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
0..1 | Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) | Who/what authenticated the document | |||||
![]() ![]() ![]() |
0..1 | Reference(CH Core 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(CH Core DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: DocumentEntry.confidentialityCode (extensible) | ||||
![]() ![]() ![]() |
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Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 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. Constraints: ch-docref-1 Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred) Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentEntry.formatCode (preferred) | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..* | Reference(CH Core Encounter | EpisodeOfCare) | 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. | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (preferred) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (preferred) | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(CH Core Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(Resource) | Related identifiers or resources | ||||
![]() |
Path | Status | Usage | ValueSet | Version | Source |
DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.docStatus | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
DocumentReference.type | Base | preferred | DocumentEntry.typeCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.category | Base | preferred | DocumentEntry.classCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
DocumentReference.securityLabel | Base | extensible | DocumentEntry.confidentialityCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
DocumentReference.content.attachment.language | Base | preferred | DocumentEntry.languageCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.content.format | Base | preferred | DocumentEntry.formatCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
DocumentReference.context.facilityType | Base | preferred | DocumentEntry.healthcareFacilityTypeCode | 📦3.3.0-ci-build | CH Term v3.3 |
DocumentReference.context.practiceSetting | Base | preferred | DocumentEntry.practiceSettingCode | 📦3.3.0-ci-build | CH Term v3.3 |
Id | Grade | Path(s) | Description | Expression |
ch-docref-1 | warning | DocumentReference.content.attachment.contentType | The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType |
memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
|
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()
|
This structure is derived from CHCoreDocumentReference
Other representations of profile: CSV, Excel, Schematron