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: MheroCommunicationRequest

mHero profile for Communication Request.

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from CommunicationRequest

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*CommunicationRequestA request for information to be sent 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 I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mhero-comm-req-flow-starts I0..1(Complex)Optional Extensions Element
URL: http://mHero.org/fhir/StructureDefinition/mhero-comm-req-flow-starts
... mhero-comm-req-broadcast-starts I0..1(Complex)Optional Extensions Element
URL: http://mHero.org/fhir/StructureDefinition/mhero-comm-req-broadcast-starts
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierUnique identifier
... basedOn ΣI0..*Reference(Resource)Fulfills plan or proposal
... replaces ΣI0..*Reference(CommunicationRequest)Request(s) replaced by this request
... groupIdentifier ΣI0..1IdentifierComposite request this is part of
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... statusReason I0..1CodeableConceptReason for current status
Binding: (unbound) (example)
... category I0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if request is prohibiting action
... medium I0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject I0..1Reference(Patient | Group)Focus of message
... about I0..*Reference(Resource)Resources that pertain to this communication request
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... 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)
... occurrence[x] ΣI0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn ΣI0..1dateTimeWhen request transitioned to being actionable
... requester ΣI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... 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..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why is communication needed?
... note I0..*AnnotationComments made about communication request

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*CommunicationRequestA request for information to be sent to a receiver
... status ?!ΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... payload I0..*BackboneElementMessage payload
... recipient I0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)Message recipient

doco Documentation for this format

This structure is derived from CommunicationRequest

Differential View

This structure is derived from CommunicationRequest

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest I0..*CommunicationRequestA request for information to be sent 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 I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mhero-comm-req-flow-starts I0..1(Complex)Optional Extensions Element
URL: http://mHero.org/fhir/StructureDefinition/mhero-comm-req-flow-starts
... mhero-comm-req-broadcast-starts I0..1(Complex)Optional Extensions Element
URL: http://mHero.org/fhir/StructureDefinition/mhero-comm-req-broadcast-starts
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierUnique identifier
... basedOn ΣI0..*Reference(Resource)Fulfills plan or proposal
... replaces ΣI0..*Reference(CommunicationRequest)Request(s) replaced by this request
... groupIdentifier ΣI0..1IdentifierComposite request this is part of
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... statusReason I0..1CodeableConceptReason for current status
Binding: (unbound) (example)
... category I0..*CodeableConceptMessage category
Binding: CommunicationCategory (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if request is prohibiting action
... medium I0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject I0..1Reference(Patient | Group)Focus of message
... about I0..*Reference(Resource)Resources that pertain to this communication request
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... 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)
... occurrence[x] ΣI0..1When scheduled
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... authoredOn ΣI0..1dateTimeWhen request transitioned to being actionable
... requester ΣI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... 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..*CodeableConceptWhy is communication needed?
Binding: v3 Code System ActReason (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why is communication needed?
... note I0..*AnnotationComments made about communication request

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
CommunicationRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
CommunicationRequest.statusrequiredRequestStatus
CommunicationRequest.statusReasonexample
CommunicationRequest.categoryexampleCommunicationCategory
CommunicationRequest.priorityrequiredRequestPriority
CommunicationRequest.mediumexamplev3.ParticipationMode
CommunicationRequest.reasonCodeexamplev3.ActReason

Constraints

IdPathDetailsRequirements