CH EPR mHealth (R4)
3.0.0-ballot - ballot Switzerland flag

This page is part of the CH EPR mHealth (R4) (v3.0.0-ballot: Draft Ballot 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CH MHD SubmissionSet Comprehensive

Official URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-submissionset-comprehensive Version: 3.0.0-ballot
Draft as of 2021-04-15 Computable Name: CHMhdSubmissionSetComprehensive

Copyright/Legal: CC0-1.0

CH MHD SubmissionSet Comprehensive

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from SubmissionSetComprehensiveUnContained

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*SubmissionSetComprehensiveUnContainedA list is a curated collection of resources
... extension 3..*ExtensionExtension
... extension:designationType S1..1DesignationTypeClinical code of the List
Binding: SubmissionSet.contentTypeCode (required)
... extension:sourceId S1..1SourceIdPublisher organization identity of the SubmissionSet
... identifier S0..*Identifieridentifier, for uniqueID set use to ususal
... status S1..1codecurrent | retired | entered-in-error
... mode S1..1codeworking | snapshot | changes
... code S1..1CodeableConceptWhat the purpose of this list is
... subject S1..1Reference(CH Core Patient) {r}If all resources have the same subject
... date S1..1dateTimeWhen the list was prepared
... source S0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
.... extension:authorOrg 0..0
... entry S1..*BackboneElementEntries in the list
.... item S1..1Reference(CH MHD DocumentReference Comprehensive) {r, b}Actual entry

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
List.extension:designationTyperequiredSubmissionSetContentTypeCode
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C0..*SubmissionSetComprehensiveUnContainedA list is a curated collection of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 3..*ExtensionExtension
Slice: Unordered, Open by value:url
... designationType S1..1CodeableConceptClinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
... intendedRecipient 0..*Reference()Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... authorAuthorRole S0..1CodingThe SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... Slices for identifier S0..*Identifieridentifier, for uniqueID set use to ususal
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1SubmissionSetUniqueIdIdentifierAn identifier intended for computation
.... identifier:entryUUID 0..*EntryUUIDIdentifierAn identifier intended for computation
... status ?!SΣ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... mode ?!SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
... code SΣ1..1CodeableConceptWhat the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: submissionset
... subject SΣ1..1Reference(CH Core Patient) {r}If all resources have the same subject
... date SΣ1..1dateTimeWhen the list was prepared
... source SΣ0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... note 0..1AnnotationComments about the list
... entry SC1..*BackboneElementEntries in the list
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item S1..1Reference(CH MHD DocumentReference Comprehensive) {r, b}Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
List.statusrequiredPattern: current
List.moderequiredPattern: working
List.coderequiredPattern: submissionset

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C0..*SubmissionSetComprehensiveUnContainedA list is a curated collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 3..*ExtensionExtension
Slice: Unordered, Open by value:url
... designationType S1..1CodeableConceptClinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
... sourceId S1..1IdentifierPublisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
... intendedRecipient 0..*Reference()Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... authorAuthorRole S0..1CodingThe SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... Slices for identifier S0..*Identifieridentifier, for uniqueID set use to ususal
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1SubmissionSetUniqueIdIdentifierAn identifier intended for computation
.... identifier:entryUUID 0..*EntryUUIDIdentifierAn identifier intended for computation
... status ?!SΣ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... mode ?!SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code SΣ1..1CodeableConceptWhat the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: submissionset
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(CH Core Patient) {r}If all resources have the same subject
... date SΣ1..1dateTimeWhen the list was prepared
... source SΣ0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... note 0..1AnnotationComments about the list
... entry SC1..*BackboneElementEntries in the list
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item S1..1Reference(CH MHD DocumentReference Comprehensive) {r, b}Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
List.meta.securityextensibleAll Security Labels
List.meta.tagexampleCommonTags
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
List.statusrequiredPattern: current
List.moderequiredPattern: working
List.coderequiredPattern: submissionset
List.source.typeextensibleResourceType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SubmissionSetComprehensiveUnContained

Differential View

This structure is derived from SubmissionSetComprehensiveUnContained

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*SubmissionSetComprehensiveUnContainedA list is a curated collection of resources
... extension 3..*ExtensionExtension
... extension:designationType S1..1DesignationTypeClinical code of the List
Binding: SubmissionSet.contentTypeCode (required)
... extension:sourceId S1..1SourceIdPublisher organization identity of the SubmissionSet
... identifier S0..*Identifieridentifier, for uniqueID set use to ususal
... status S1..1codecurrent | retired | entered-in-error
... mode S1..1codeworking | snapshot | changes
... code S1..1CodeableConceptWhat the purpose of this list is
... subject S1..1Reference(CH Core Patient) {r}If all resources have the same subject
... date S1..1dateTimeWhen the list was prepared
... source S0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
.... extension:authorOrg 0..0
... entry S1..*BackboneElementEntries in the list
.... item S1..1Reference(CH MHD DocumentReference Comprehensive) {r, b}Actual entry

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
List.extension:designationTyperequiredSubmissionSetContentTypeCode

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C0..*SubmissionSetComprehensiveUnContainedA list is a curated collection of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 3..*ExtensionExtension
Slice: Unordered, Open by value:url
... designationType S1..1CodeableConceptClinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
... intendedRecipient 0..*Reference()Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... authorAuthorRole S0..1CodingThe SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... Slices for identifier S0..*Identifieridentifier, for uniqueID set use to ususal
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1SubmissionSetUniqueIdIdentifierAn identifier intended for computation
.... identifier:entryUUID 0..*EntryUUIDIdentifierAn identifier intended for computation
... status ?!SΣ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... mode ?!SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
... code SΣ1..1CodeableConceptWhat the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: submissionset
... subject SΣ1..1Reference(CH Core Patient) {r}If all resources have the same subject
... date SΣ1..1dateTimeWhen the list was prepared
... source SΣ0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... note 0..1AnnotationComments about the list
... entry SC1..*BackboneElementEntries in the list
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item S1..1Reference(CH MHD DocumentReference Comprehensive) {r, b}Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
List.statusrequiredPattern: current
List.moderequiredPattern: working
List.coderequiredPattern: submissionset

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C0..*SubmissionSetComprehensiveUnContainedA list is a curated collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 3..*ExtensionExtension
Slice: Unordered, Open by value:url
... designationType S1..1CodeableConceptClinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
... sourceId S1..1IdentifierPublisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
... intendedRecipient 0..*Reference()Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... authorAuthorRole S0..1CodingThe SubmissionSet.Author element MAY be used to track the user who made the latest changes to the document metadata.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... Slices for identifier S0..*Identifieridentifier, for uniqueID set use to ususal
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1SubmissionSetUniqueIdIdentifierAn identifier intended for computation
.... identifier:entryUUID 0..*EntryUUIDIdentifierAn identifier intended for computation
... status ?!SΣ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... mode ?!SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
... title Σ0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code SΣ1..1CodeableConceptWhat the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: submissionset
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(CH Core Patient) {r}If all resources have the same subject
... date SΣ1..1dateTimeWhen the list was prepared
... source SΣ0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... note 0..1AnnotationComments about the list
... entry SC1..*BackboneElementEntries in the list
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item S1..1Reference(CH MHD DocumentReference Comprehensive) {r, b}Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
List.meta.securityextensibleAll Security Labels
List.meta.tagexampleCommonTags
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
List.statusrequiredPattern: current
List.moderequiredPattern: working
List.coderequiredPattern: submissionset
List.source.typeextensibleResourceType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SubmissionSetComprehensiveUnContained

Summary

Mandatory: 2 elements
Must-Support: 12 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron