CH EMR (R4)
1.0.0-ballot - ballot
CH EMR (R4)
1.0.0-ballot - ballot
CH EMR (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-emr/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-emr/StructureDefinition/ch-emr-documentreference-advance-directive | Version: 1.0.0-ballot | ||||
| Active as of 2026-10-23 | Computable Name: ChEmrDocumentReferenceAdvanceDirective | ||||
Copyright/Legal: CC0-1.0 |
|||||
Reference to advance directives and emergency medical
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  DocumentReference |
C | 0..* | CHCoreDocumentReference(7.0.0-ballot) | CH Core DocumentReference Constraints: ch-emr-ad-locator | ||||||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |||||||||
 type |
1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Advance Directive Type (extensible)
| |||||||||
| category |
1..* | CodeableConcept | Categorization of document Binding: DocumentEntryClassCode (3.4.0) (preferred)
| |||||||||
 subject |
0..1 | Reference(CH IPS Patient) {b} | Who/what is the subject of the document | |||||||||
| date |
1..1 | instant | When this document reference was created
| |||||||||
| author |
0..* | Reference(CH IPS Practitioner | CH IPS PractitionerRole | CH IPS Organization | CH IPS Patient | CH Emergency Record RelatedPerson) {b} | Who and/or what authored the document | |||||||||
| custodian |
0..1 | Reference(CH IPS Organization) {b} | Organization which maintains the document
| |||||||||
| description |
0..1 | string | Human-readable description
| |||||||||
 content |
1..* | BackboneElement | Document referenced | |||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| attachment |
1..1 | Attachment | Where to access the document | |||||||||
| url |
0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png
| |||||||||
 title |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.type | Base | extensible | Advance Directive Type | 📦1.0.0-ballot | This IG |
| DocumentReference.category | Base | preferred | DocumentEntry.classCode | 📍3.4.0 | CH Term v3.4 |
| Id | Grade | Path(s) | Description | Expression |
| ch-emr-ad-locator | error | DocumentReference | An advance directive DocumentReference SHALL convey where the original can be found: provide content.attachment.url, custodian, or description. |
content.attachment.url.exists() or custodian.exists() or description.exists()
|
| 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 | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DocumentReference |
||
 type |
|
|
| category |
|
|
| date |
|
|
| custodian |
|
|
| description |
|
|
| content |
||
| attachment |
||
| url |
|
|
| title |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.type | Base | extensible | Advance Directive Type | 📦1.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ch-emr-ad-locator | error | DocumentReference | An advance directive DocumentReference SHALL convey where the original can be found: provide content.attachment.url, custodian, or description. |
content.attachment.url.exists() or custodian.exists() or description.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DocumentReference |
C | 0..* | CHCoreDocumentReference(7.0.0-ballot) | CH Core DocumentReference Constraints: ch-emr-ad-locator | ||||||||
| id |
0..1 | id | Logical id of this artifact | |||||||||
| meta |
0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
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 | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| masterIdentifier |
0..1 | Identifier | Master Version Specific Identifier | |||||||||
| identifier |
0..* | Identifier | Other identifiers for the document | |||||||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |||||||||
| docStatus |
0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | |||||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Advance Directive Type (extensible)
| |||||||||
| category |
1..* | CodeableConcept | Categorization of document Binding: DocumentEntryClassCode (3.4.0) (preferred)
| |||||||||
| subject |
0..1 | Reference(CH IPS Patient) {b} | Who/what is the subject of the document | |||||||||
| date |
1..1 | instant | When this document reference was created
| |||||||||
| author |
0..* | Reference(CH IPS Practitioner | CH IPS PractitionerRole | CH IPS Organization | CH IPS Patient | CH Emergency Record RelatedPerson) {b} | Who and/or what authored the document | |||||||||
| authenticator |
0..1 | Reference(CH Core Practitioner(7.0.0-ballot) | CH Core PractitionerRole(7.0.0-ballot) | CH Core Organization(7.0.0-ballot)) | Who/what authenticated the document | |||||||||
| custodian |
0..1 | Reference(CH IPS Organization) {b} | Organization which maintains the document
| |||||||||
 relatesTo |
0..* | BackboneElement | Relationships to other documents | |||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||||||
| target |
1..1 | Reference(CH Core DocumentReference(7.0.0-ballot)) | Target of the relationship | |||||||||
| description |
0..1 | string | Human-readable description
| |||||||||
| securityLabel |
0..* | CodeableConcept | Document security-tags Binding: DocumentEntryConfidentialityCode (3.4.0) (extensible) | |||||||||
| content |
1..* | BackboneElement | Document referenced | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| attachment |
1..1 | Attachment | Where to access the document | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| contentType |
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 | ||||||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: DocumentEntryLanguageCode (3.4.0) (preferred) Example General: en-AU | |||||||||
| url |
0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png
| |||||||||
| size |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||||||
| hash |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||||||
| title |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo
| |||||||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||||||
| format |
0..1 | Coding | Format/content rules for the document Binding: DocumentEntryFormatCode (3.4.0) (preferred) | |||||||||
| context |
0..1 | BackboneElement | Clinical context of document | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| encounter |
0..* | Reference(CH Core Encounter(7.0.0-ballot) | EpisodeOfCare) | Context of the document content | |||||||||
| event |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||||||
| period |
0..1 | Period | Time of service that is being documented | |||||||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: DocumentEntryHealthcareFacilityTypeCode (3.4.0) (preferred) | |||||||||
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntryPracticeSettingCode (3.4.0) (preferred) | |||||||||
| sourcePatientInfo |
0..1 | Reference(CH Core Patient(7.0.0-ballot)) | Patient demographics from source | |||||||||
| related |
0..* | Reference(Resource) | Related identifiers or resources | |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DocumentReference |
||
| type |
|
|
| category |
|
|
| date |
|
|
| custodian |
|
|
| description |
|
|
| content |
||
| attachment |
||
| url |
|
|
| title |
|
|
| Documentation for this format | ||
| 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 | extensible | Advance Directive Type | 📦1.0.0-ballot | This IG |
| DocumentReference.category | Base | preferred | DocumentEntry.classCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | DocumentEntry.confidentialityCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | DocumentEntry.languageCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.content.format | Base | preferred | DocumentEntry.formatCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.1 |
| DocumentReference.context.facilityType | Base | preferred | DocumentEntry.healthcareFacilityTypeCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.context.practiceSetting | Base | preferred | DocumentEntry.practiceSettingCode | 📍3.4.0 | CH Term v3.4 |
| 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')
|
| ch-emr-ad-locator | error | DocumentReference | An advance directive DocumentReference SHALL convey where the original can be found: provide content.attachment.url, custodian, or description. |
content.attachment.url.exists() or custodian.exists() or description.exists()
|
| 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()
|
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DocumentReference |
||
| type |
|
|
| category |
|
|
| date |
|
|
| custodian |
|
|
| description |
|
|
| content |
||
| attachment |
||
| url |
|
|
| title |
|
|
| Documentation for this format | ||
This structure is derived from CHCoreDocumentReference
Summary
Mandatory: 3 elements
Must-Support: 7 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DocumentReference |
C | 0..* | CHCoreDocumentReference(7.0.0-ballot) | CH Core DocumentReference Constraints: ch-emr-ad-locator | ||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |||||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Advance Directive Type (extensible)
| |||||||||
| category |
1..* | CodeableConcept | Categorization of document Binding: DocumentEntryClassCode (3.4.0) (preferred)
| |||||||||
| subject |
0..1 | Reference(CH IPS Patient) {b} | Who/what is the subject of the document | |||||||||
| date |
1..1 | instant | When this document reference was created
| |||||||||
| author |
0..* | Reference(CH IPS Practitioner | CH IPS PractitionerRole | CH IPS Organization | CH IPS Patient | CH Emergency Record RelatedPerson) {b} | Who and/or what authored the document | |||||||||
| custodian |
0..1 | Reference(CH IPS Organization) {b} | Organization which maintains the document
| |||||||||
| description |
0..1 | string | Human-readable description
| |||||||||
| content |
1..* | BackboneElement | Document referenced | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| attachment |
1..1 | Attachment | Where to access the document | |||||||||
| url |
0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png
| |||||||||
| title |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo
| |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DocumentReference |
||
| type |
|
|
| category |
|
|
| date |
|
|
| custodian |
|
|
| description |
|
|
| content |
||
| attachment |
||
| url |
|
|
| title |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.type | Base | extensible | Advance Directive Type | 📦1.0.0-ballot | This IG |
| DocumentReference.category | Base | preferred | DocumentEntry.classCode | 📍3.4.0 | CH Term v3.4 |
| Id | Grade | Path(s) | Description | Expression |
| ch-emr-ad-locator | error | DocumentReference | An advance directive DocumentReference SHALL convey where the original can be found: provide content.attachment.url, custodian, or description. |
content.attachment.url.exists() or custodian.exists() or description.exists()
|
| 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: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DocumentReference |
C | 0..* | CHCoreDocumentReference(7.0.0-ballot) | CH Core DocumentReference Constraints: ch-emr-ad-locator | ||||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Advance Directive Type (extensible)
| |||||||||
| category |
1..* | CodeableConcept | Categorization of document
| |||||||||
| subject |
0..1 | Reference(CH IPS Patient) {b} | Who/what is the subject of the document | |||||||||
| date |
1..1 | instant | When this document reference was created
| |||||||||
| author |
0..* | Reference(CH IPS Practitioner | CH IPS PractitionerRole | CH IPS Organization | CH IPS Patient | CH Emergency Record RelatedPerson) {b} | Who and/or what authored the document | |||||||||
| custodian |
0..1 | Reference(CH IPS Organization) {b} | Organization which maintains the document
| |||||||||
| description |
0..1 | string | Human-readable description
| |||||||||
| content |
||||||||||||
| attachment |
||||||||||||
| data |
0..0 | Data inline, base64ed | ||||||||||
| url |
0..1 | url | Uri where the data can be found
| |||||||||
| title |
0..1 | string | Label to display in place of the data
| |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DocumentReference |
||
| type |
|
|
| category |
|
|
| date |
|
|
| custodian |
|
|
| description |
|
|
| content |
||
| attachment |
||
| url |
|
|
| title |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.type | Base | extensible | Advance Directive Type | 📦1.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ch-emr-ad-locator | error | DocumentReference | An advance directive DocumentReference SHALL convey where the original can be found: provide content.attachment.url, custodian, or description. |
content.attachment.url.exists() or custodian.exists() or description.exists()
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DocumentReference |
C | 0..* | CHCoreDocumentReference(7.0.0-ballot) | CH Core DocumentReference Constraints: ch-emr-ad-locator | ||||||||
| id |
0..1 | id | Logical id of this artifact | |||||||||
| meta |
0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
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 | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| masterIdentifier |
0..1 | Identifier | Master Version Specific Identifier | |||||||||
| identifier |
0..* | Identifier | Other identifiers for the document | |||||||||
| status |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | |||||||||
| docStatus |
0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | |||||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Advance Directive Type (extensible)
| |||||||||
| category |
1..* | CodeableConcept | Categorization of document Binding: DocumentEntryClassCode (3.4.0) (preferred)
| |||||||||
| subject |
0..1 | Reference(CH IPS Patient) {b} | Who/what is the subject of the document | |||||||||
| date |
1..1 | instant | When this document reference was created
| |||||||||
| author |
0..* | Reference(CH IPS Practitioner | CH IPS PractitionerRole | CH IPS Organization | CH IPS Patient | CH Emergency Record RelatedPerson) {b} | Who and/or what authored the document | |||||||||
| authenticator |
0..1 | Reference(CH Core Practitioner(7.0.0-ballot) | CH Core PractitionerRole(7.0.0-ballot) | CH Core Organization(7.0.0-ballot)) | Who/what authenticated the document | |||||||||
| custodian |
0..1 | Reference(CH IPS Organization) {b} | Organization which maintains the document
| |||||||||
| relatesTo |
0..* | BackboneElement | Relationships to other documents | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||||||
| target |
1..1 | Reference(CH Core DocumentReference(7.0.0-ballot)) | Target of the relationship | |||||||||
| description |
0..1 | string | Human-readable description
| |||||||||
| securityLabel |
0..* | CodeableConcept | Document security-tags Binding: DocumentEntryConfidentialityCode (3.4.0) (extensible) | |||||||||
| content |
1..* | BackboneElement | Document referenced | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| attachment |
1..1 | Attachment | Where to access the document | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| contentType |
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 | ||||||||
| language |
0..1 | code | Human language of the content (BCP-47) Binding: DocumentEntryLanguageCode (3.4.0) (preferred) Example General: en-AU | |||||||||
| url |
0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png
| |||||||||
| size |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||||||
| hash |
0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||||||
| title |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo
| |||||||||
| creation |
0..1 | dateTime | Date attachment was first created | |||||||||
| format |
0..1 | Coding | Format/content rules for the document Binding: DocumentEntryFormatCode (3.4.0) (preferred) | |||||||||
| context |
0..1 | BackboneElement | Clinical context of document | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| encounter |
0..* | Reference(CH Core Encounter(7.0.0-ballot) | EpisodeOfCare) | Context of the document content | |||||||||
| event |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||||||
| period |
0..1 | Period | Time of service that is being documented | |||||||||
| facilityType |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: DocumentEntryHealthcareFacilityTypeCode (3.4.0) (preferred) | |||||||||
| practiceSetting |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntryPracticeSettingCode (3.4.0) (preferred) | |||||||||
| sourcePatientInfo |
0..1 | Reference(CH Core Patient(7.0.0-ballot)) | Patient demographics from source | |||||||||
| related |
0..* | Reference(Resource) | Related identifiers or resources | |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DocumentReference |
||
| type |
|
|
| category |
|
|
| date |
|
|
| custodian |
|
|
| description |
|
|
| content |
||
| attachment |
||
| url |
|
|
| title |
|
|
| Documentation for this format | ||
| 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 | extensible | Advance Directive Type | 📦1.0.0-ballot | This IG |
| DocumentReference.category | Base | preferred | DocumentEntry.classCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | DocumentEntry.confidentialityCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | DocumentEntry.languageCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.content.format | Base | preferred | DocumentEntry.formatCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.1 |
| DocumentReference.context.facilityType | Base | preferred | DocumentEntry.healthcareFacilityTypeCode | 📍3.4.0 | CH Term v3.4 |
| DocumentReference.context.practiceSetting | Base | preferred | DocumentEntry.practiceSettingCode | 📍3.4.0 | CH Term v3.4 |
| 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')
|
| ch-emr-ad-locator | error | DocumentReference | An advance directive DocumentReference SHALL convey where the original can be found: provide content.attachment.url, custodian, or description. |
content.attachment.url.exists() or custodian.exists() or description.exists()
|
| 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()
|
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| DocumentReference |
||
| type |
|
|
| category |
|
|
| date |
|
|
| custodian |
|
|
| description |
|
|
| content |
||
| attachment |
||
| url |
|
|
| title |
|
|
| Documentation for this format | ||
This structure is derived from CHCoreDocumentReference
Summary
Mandatory: 3 elements
Must-Support: 7 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron