mHero Implementation Guide
0.1.0 - CI Build

mHero Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: MheroCommunication

mHero profile for Communication.

The official URL for this profile is: 

http://mHero.org/fhir/StructureDefinition/mhero-communication

Formal Views of Profile Content

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

This structure is derived from Communication

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Extensions

This structure refers to these extensions:

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... mhero-comm-flow-run 1..1Reference()Extension
URL: http://mHero.org/fhir/StructureDefinition/mhero-comm-flow-run
... status S1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... received S0..1dateTimeWhen received
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... payload S0..*BackboneElementMessage payload

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I1..*ExtensionExtension
Slice: Unordered, Open by value:url
... mhero-comm-flow-run I1..1Reference()Optional Extensions Element
URL: http://mHero.org/fhir/StructureDefinition/mhero-comm-flow-run
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierUnique identifier
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(Resource)Request fulfilled by this communication
... partOf ΣI0..*Reference(Resource)Part of this action
... inResponseTo I0..*Reference(Communication)Reply to
... status ?!SΣI1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... statusReason ΣI0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example)
... category I0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... medium I0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject ΣI0..1Reference(Patient | Group)Focus of message
... topic I0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example)
... about I0..*Reference(Resource)Resources that pertain to this communication
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... sent SI0..1dateTimeWhen sent
... received SI0..1dateTimeWhen received
... recipient SI0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender I0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode ΣI0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... payload SI0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] I1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... note I0..*AnnotationComments made about the communication

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
... status ?!ΣI1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... sent I0..1dateTimeWhen sent
... received I0..1dateTimeWhen received
... payload I0..*BackboneElementMessage payload

doco Documentation for this format

This structure is derived from Communication

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication 0..*CommunicationA record of information transmitted from a sender to a receiver
... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... mhero-comm-flow-run 1..1Reference()Extension
URL: http://mHero.org/fhir/StructureDefinition/mhero-comm-flow-run
... status S1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... received S0..1dateTimeWhen received
... recipient S0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... payload S0..*BackboneElementMessage payload

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*CommunicationA record of information transmitted from a sender to a receiver
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I1..*ExtensionExtension
Slice: Unordered, Open by value:url
... mhero-comm-flow-run I1..1Reference()Optional Extensions Element
URL: http://mHero.org/fhir/StructureDefinition/mhero-comm-flow-run
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierUnique identifier
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(Resource)Request fulfilled by this communication
... partOf ΣI0..*Reference(Resource)Part of this action
... inResponseTo I0..*Reference(Communication)Reply to
... status ?!SΣI1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required)
... statusReason ΣI0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example)
... category I0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... medium I0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject ΣI0..1Reference(Patient | Group)Focus of message
... topic I0..1CodeableConceptDescription of the purpose/content
Binding: CommunicationTopic (example)
... about I0..*Reference(Resource)Resources that pertain to this communication
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... sent SI0..1dateTimeWhen sent
... received SI0..1dateTimeWhen received
... recipient SI0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient
... sender I0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)Message sender
... reasonCode ΣI0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... payload SI0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] I1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(Resource)
... note I0..*AnnotationComments made about the communication

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Communication.statusrequiredEventStatus
Communication.statusReasonexampleCommunicationNotDoneReason
Communication.categoryexampleCommunicationCategory
Communication.priorityrequiredRequestPriority
Communication.mediumexamplev3.ParticipationMode
Communication.topicexampleCommunicationTopic
Communication.reasonCodeexampleSNOMEDCTClinicalFindings

Constraints

IdPathDetailsRequirements