CH EPR mHealth (R4)
0.1.1 - Draft Standard for Trial Use
CH EPR mHealth (R4)
0.1.1 - Draft Standard for Trial Use
This page is part of the CH EPR mHealth (R4) (v0.1.1: DSTU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
IHE MHD Profile on DocumentReference (DocumentEntry) from a Query with Comprehensive Metadata (aka XDS-on-FHIR).
The official URL for this profile is:
http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-query-comprehensive-documentreference
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from IHE_MHD_Provide_Comprehensive_DocumentReference_CH
This structure is derived from IHE_MHD_Provide_Comprehensive_DocumentReference_CH
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DocumentReference | I | 0..* | IHE_MHD_Provide_Comprehensive_DocumentReference_CH | CH MHD Query Comprehensive DocumentReference ch-mhd: The resource is not conform to the MHD profile from https://github.com/IHE/ITI.MHD |
  identifier | 1..* | Identifier | Other identifiers for the document | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentReference | I | 0..* | IHE_MHD_Provide_Comprehensive_DocumentReference_CH | CH MHD Query Comprehensive DocumentReference |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
 ch-ext-deletionstatus | I | 0..1 | Coding | Deletion status of the document URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-deletionstatus |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| masterIdentifier | SΣI | 1..1 | Identifier | Master Version Specific Identifier |
| identifier | SΣI | 1..* | Identifier | Other identifiers for the document |
| status | ?!ΣI | 1..1 | code | current | superseded Binding: DocumentReferenceStatus (required) |
| type | SΣI | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (preferred) |
| category | SΣI | 1..1 | CodeableConcept | Categorization of document Binding: DocumentEntry.classCode (preferred) |
 subject | SΣI | 1..1 | Reference(CH Core Patient Profile) {rb} | Who/what is the subject of the document |
| date | SΣI | 1..1 | instant | When this document reference was created |
| author | SΣI | 0..* | Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile | Device | CH Core Patient Profile | RelatedPerson) {c} | Who and/or what authored the document |
| authenticator | I | 0..1 | Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile) {c} | Who/what authenticated the document |
 relatesTo | SΣI | 0..* | BackboneElement | Relationships to other documents |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | ΣI | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
| target | ΣI | 1..1 | Reference(DocumentReference) | Target of the relationship |
| description | ΣI | 0..1 | string | Human-readable description |
| securityLabel | SΣI | 1..* | CodeableConcept | Document security-tags Binding: DocumentEntry.confidentialityCode (preferred) |
| content | SΣI | 1..1 | BackboneElement | Document referenced |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| attachment | SΣI | 1..1 | Attachment | Where to access the document |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| contentType | SΣI | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required) Example General: text/plain; charset=UTF-8, image/png |
| language | SΣI | 1..1 | code | Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred) Example General: en-AU |
| url | SΣI | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | ΣI | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | ΣI | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | ΣI | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
| creation | ΣI | 1..1 | dateTime | Date attachment was first created |
| format | SΣI | 1..1 | Coding | Format/content rules for the document Binding: DocumentEntry.formatCode (preferred) |
 context | ΣI | 1..1 | BackboneElement | Clinical context of document |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| encounter | I | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content |
| event | I | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example) |
| period | SΣI | 0..1 | Period | Time of service that is being documented |
| facilityType | SI | 1..1 | CodeableConcept | Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (preferred) |
| practiceSetting | SI | 1..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (preferred) |
| sourcePatientInfo | SI | 1..1 | Reference(CH Core Patient Profile) {c} | Patient demographics from source |
| related | I | 0..* | Reference(Resource) | Related identifiers or resources |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
This structure is derived from IHE_MHD_Provide_Comprehensive_DocumentReference_CH
Differential View
This structure is derived from IHE_MHD_Provide_Comprehensive_DocumentReference_CH
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentReference | I | 0..* | IHE_MHD_Provide_Comprehensive_DocumentReference_CH | CH MHD Query Comprehensive DocumentReference ch-mhd: The resource is not conform to the MHD profile from https://github.com/IHE/ITI.MHD |
| identifier | 1..* | Identifier | Other identifiers for the document | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DocumentReference | I | 0..* | IHE_MHD_Provide_Comprehensive_DocumentReference_CH | CH MHD Query Comprehensive DocumentReference |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ch-ext-deletionstatus | I | 0..1 | Coding | Deletion status of the document URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-deletionstatus |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| masterIdentifier | SΣI | 1..1 | Identifier | Master Version Specific Identifier |
| identifier | SΣI | 1..* | Identifier | Other identifiers for the document |
| status | ?!ΣI | 1..1 | code | current | superseded Binding: DocumentReferenceStatus (required) |
| type | SΣI | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (preferred) |
| category | SΣI | 1..1 | CodeableConcept | Categorization of document Binding: DocumentEntry.classCode (preferred) |
| subject | SΣI | 1..1 | Reference(CH Core Patient Profile) {rb} | Who/what is the subject of the document |
| date | SΣI | 1..1 | instant | When this document reference was created |
| author | SΣI | 0..* | Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile | Device | CH Core Patient Profile | RelatedPerson) {c} | Who and/or what authored the document |
| authenticator | I | 0..1 | Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile) {c} | Who/what authenticated the document |
| relatesTo | SΣI | 0..* | BackboneElement | Relationships to other documents |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | ΣI | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
| target | ΣI | 1..1 | Reference(DocumentReference) | Target of the relationship |
| description | ΣI | 0..1 | string | Human-readable description |
| securityLabel | SΣI | 1..* | CodeableConcept | Document security-tags Binding: DocumentEntry.confidentialityCode (preferred) |
| content | SΣI | 1..1 | BackboneElement | Document referenced |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| attachment | SΣI | 1..1 | Attachment | Where to access the document |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| contentType | SΣI | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required) Example General: text/plain; charset=UTF-8, image/png |
| language | SΣI | 1..1 | code | Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred) Example General: en-AU |
| url | SΣI | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | ΣI | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
| hash | ΣI | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | ΣI | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
| creation | ΣI | 1..1 | dateTime | Date attachment was first created |
| format | SΣI | 1..1 | Coding | Format/content rules for the document Binding: DocumentEntry.formatCode (preferred) |
| context | ΣI | 1..1 | BackboneElement | Clinical context of document |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| encounter | I | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content |
| event | I | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example) |
| period | SΣI | 0..1 | Period | Time of service that is being documented |
| facilityType | SI | 1..1 | CodeableConcept | Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (preferred) |
| practiceSetting | SI | 1..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (preferred) |
| sourcePatientInfo | SI | 1..1 | Reference(CH Core Patient Profile) {c} | Patient demographics from source |
| related | I | 0..* | Reference(Resource) | Related identifiers or resources |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| DocumentReference.language | preferred | CommonLanguages Max Binding: AllLanguages |
| DocumentReference.status | required | DocumentReferenceStatus |
| DocumentReference.type | preferred | DocumentEntryTypeCode |
| DocumentReference.category | preferred | DocumentEntryClassCode |
| DocumentReference.relatesTo.code | required | DocumentRelationshipType |
| DocumentReference.securityLabel | preferred | DocumentEntryConfidentialityCode |
| DocumentReference.content.attachment.contentType | required | Mime Types |
| DocumentReference.content.attachment.language | preferred | DocumentEntryLanguageCode |
| DocumentReference.content.format | preferred | DocumentEntryFormatCode |
| DocumentReference.context.event | example | v3.ActCode |
| DocumentReference.context.facilityType | preferred | DocumentEntryHealthcareFacilityTypeCode |
| DocumentReference.context.practiceSetting | preferred | DocumentEntryPracticeSettingCode |
| DocumentReference.context.related.type | extensible | ResourceType |
| Id | Path | Details | Requirements |
| dom-2 | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
| ch-mhd | DocumentReference | The resource is not conform to the MHD profile from https://github.com/IHE/ITI.MHD : conformsTo('http://ihe.net/fhir/ihe.mhd.fhir/StructureDefinition/IHE.MHD.Provide.Comprehensive.DocumentReference') | |
| ele-1 | DocumentReference.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.extension:deletionStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.extension:deletionStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.masterIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.authenticator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.relatesTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.relatesTo.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.relatesTo.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.relatesTo.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.relatesTo.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.relatesTo.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.relatesTo.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.securityLabel | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.content.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.content.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.content.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.content.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.content.attachment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.content.attachment.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.content.attachment.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.content.attachment.contentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ch-docref-1 | DocumentReference.content.attachment.contentType | The following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType : exists() | |
| ele-1 | DocumentReference.content.attachment.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.content.attachment.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.content.attachment.size | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.content.attachment.hash | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.content.attachment.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.content.attachment.creation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.content.format | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.context.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.context.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.context.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.context.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.event | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.facilityType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.practiceSetting | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.sourcePatientInfo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.related | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.related.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | DocumentReference.context.related.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | DocumentReference.context.related.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.related.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.related.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | DocumentReference.context.related.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |