Mobile access to Health Documents (MHD)
4.2.2 - Trial-Implementation International flag

This page is part of the IHE Mobile Access to Health Documents (v4.2.2: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: MHD SubmissionSet Minimal

Official URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.SubmissionSet Version: 4.2.2
Active as of 2024-05-18 Computable Name: SubmissionSet

A profile on the List resource for MHD SubmissionSet.

Usage:

Formal Views of Profile Content

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

This structure is derived from MhdList

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..* MhdList A list is a curated collection of resources
... meta
.... profile 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:designationType S 0..1 DesignationType Clinical code of the List
.... sourceId 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status 1..1 code current | retired | entered-in-error
Required Pattern: current
... mode 1..1 code working | snapshot | changes
Required Pattern: working
... title 0..1 string Descriptive name for the list
... code 1..1 CodeableConcept What the purpose of this list is
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
... subject S 0..1 Reference(Patient) If all resources have the same subject
... encounter 0..0
... date 1..1 dateTime When the list was prepared
... source S 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... Slices for extension Content/Rules for all slices
..... authorOrg 0..1 Reference(Organization) Author organization of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-authorOrg
... orderedBy 0..0
... note 0..1 Annotation Comments about the list
... entry
.... flag 0..0
.... deleted 0..0
.... date 0..0
.... item 1..1 Reference(DocumentReference | List) Actual entry
... emptyReason 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* MhdList A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... designationType S 0..1 CodeableConcept Clinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
.... sourceId 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


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


Required Pattern: working
... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code Σ 1..1 CodeableConcept What the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
... subject SΣ 0..1 Reference(Patient) If all resources have the same subject
... date Σ 1..1 dateTime When the list was prepared
... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... Slices for extension Content/Rules for all slices
..... authorOrg 0..1 Reference(Organization) Author organization of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-authorOrg
... note 0..1 Annotation Comments about the list

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.coderequiredPattern: submissionset
https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* MhdList A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags 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..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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... designationType S 0..1 CodeableConcept Clinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
.... sourceId 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


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


Required Pattern: working
... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code Σ 1..1 CodeableConcept What the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 0..1 Reference(Patient) If all resources have the same subject
... date Σ 1..1 dateTime When the list was prepared
... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... authorOrg 0..1 Reference(Organization) Author organization of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-authorOrg
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..1 Annotation Comments about the list
... entry C 0..* BackboneElement Entries in the list
.... 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
.... item 1..1 Reference(DocumentReference | List) Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
List.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.coderequiredPattern: submissionset
https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS
from this IG
List.source.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

This structure is derived from MhdList

Summary

Mandatory: 3 elements
Must-Support: 3 elements
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of List.identifier

Differential View

This structure is derived from MhdList

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..* MhdList A list is a curated collection of resources
... meta
.... profile 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:designationType S 0..1 DesignationType Clinical code of the List
.... sourceId 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status 1..1 code current | retired | entered-in-error
Required Pattern: current
... mode 1..1 code working | snapshot | changes
Required Pattern: working
... title 0..1 string Descriptive name for the list
... code 1..1 CodeableConcept What the purpose of this list is
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
... subject S 0..1 Reference(Patient) If all resources have the same subject
... encounter 0..0
... date 1..1 dateTime When the list was prepared
... source S 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... Slices for extension Content/Rules for all slices
..... authorOrg 0..1 Reference(Organization) Author organization of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-authorOrg
... orderedBy 0..0
... note 0..1 Annotation Comments about the list
... entry
.... flag 0..0
.... deleted 0..0
.... date 0..0
.... item 1..1 Reference(DocumentReference | List) Actual entry
... emptyReason 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* MhdList A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... designationType S 0..1 CodeableConcept Clinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
.... sourceId 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


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


Required Pattern: working
... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code Σ 1..1 CodeableConcept What the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
... subject SΣ 0..1 Reference(Patient) If all resources have the same subject
... date Σ 1..1 dateTime When the list was prepared
... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... Slices for extension Content/Rules for all slices
..... authorOrg 0..1 Reference(Organization) Author organization of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-authorOrg
... note 0..1 Annotation Comments about the list

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.coderequiredPattern: submissionset
https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* MhdList A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags 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..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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... designationType S 0..1 CodeableConcept Clinical code of the List
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType
.... sourceId 1..1 Identifier Publisher organization identity of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-sourceId
.... intendedRecipient 0..* Reference(Practitioner | Organization | Patient | RelatedPerson | Group | Device | Location) Intended recipient of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-intendedRecipient
... Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:uniqueId 0..1 SubmissionSetUniqueIdIdentifier An identifier intended for computation
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


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


Required Pattern: working
... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code Σ 1..1 CodeableConcept What the purpose of this list is
Binding: MHD List Types ValueSet (required)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: submissionset
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 0..1 Reference(Patient) If all resources have the same subject
... date Σ 1..1 dateTime When the list was prepared
... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... authorOrg 0..1 Reference(Organization) Author organization of the SubmissionSet
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-authorOrg
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..1 Annotation Comments about the list
... entry C 0..* BackboneElement Entries in the list
.... 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
.... item 1..1 Reference(DocumentReference | List) Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
List.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.coderequiredPattern: submissionset
https://profiles.ihe.net/ITI/MHD/ValueSet/MHDlistTypesVS
from this IG
List.source.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

This structure is derived from MhdList

Summary

Mandatory: 3 elements
Must-Support: 3 elements
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of List.identifier

 

Other representations of profile: CSV, Excel, Schematron