Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_CommunicationRequest_R3

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-CommunicationRequest Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_CommunicationRequest_R3

This cross-version profile allows R5 CommunicationRequest content to be represented via FHIR STU3 CommunicationRequest resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusReason 0..1 CodeableConcept R5: Reason for current status (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.statusReason
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:intent ?! 1..1 code R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.intent
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
.... modifierExtension:doNotPerform ?! 0..1 boolean R5: True if request is prohibiting action (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.doNotPerform

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​status Base required RequestStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CommunicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error CommunicationRequest 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusReason 0..1 CodeableConcept R5: Reason for current status (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.statusReason
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:intent 1..1 code R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.intent
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
.... modifierExtension:doNotPerform 0..1 boolean R5: True if request is prohibiting action (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.doNotPerform
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: basedOn additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:replaces 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: replaces additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... recipient
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:recipient 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who to share the information with
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... topic
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:about 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Resources that pertain to this communication request additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... context
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The Encounter during which this CommunicationRequest was created additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... payload
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 CodeableConcept R5: content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content
.... contentReference
..... Slices for extension Content/Rules for all slices
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... sender
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:informationProvider 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who should share the information
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... requester
.... agent
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:requester 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who asks for the information to be shared
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusReason 0..1 CodeableConcept R5: Reason for current status (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.statusReason
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:intent ?! 1..1 code R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.intent
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
.... modifierExtension:doNotPerform ?! 0..1 boolean R5: True if request is prohibiting action (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.doNotPerform
... identifier Σ 0..* Identifier Unique identifier
... basedOn Σ 0..* Reference(Resource) Fulfills plan or proposal
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: basedOn additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:replaces 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: replaces additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code draft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
... priority Σ 0..1 code Message urgency
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
... medium 0..* CodeableConcept ​A channel of communication
Binding: ParticipationMode|2016-11-11 (example): Codes for communication mediums such as phone, fax, email, in person, etc.
... subject 0..1 Reference(Patient | Group) Focus of message
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... recipient 0..* Reference(Device | Organization | Patient | Practitioner | RelatedPerson | Group | CareTeam) Message recipient
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:recipient 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who to share the information with
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... topic 0..* Reference(Resource) Focal resources
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:about 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Resources that pertain to this communication request additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode leading to message
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The Encounter during which this CommunicationRequest was created additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... payload 0..* BackboneElement Message payload
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 CodeableConcept R5: content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... content[x] 1..1 Message part content
..... content[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... occurrence[x] Σ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... sender 0..1 Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Message sender
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:informationProvider 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who should share the information
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... requester ΣC 0..1 BackboneElement Who/what is requesting service
Constraints: cmr-1
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... agent Σ 1..1 Reference(Practitioner | Organization | Patient | RelatedPerson | Device) Individual making the request
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:requester 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who asks for the information to be shared
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... onBehalfOf ΣC 0..1 Reference(Organization) Organization agent is acting for
... reasonCode Σ 0..* CodeableConcept ​Why is communication needed?
Binding: ActReason|2016-11-11 (example): Codes for describing reasons for the occurrence of a communication.
... reasonReference Σ 0..* Reference(Condition | Observation) Why is communication needed?
... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
CommunicationRequest.​status Base required RequestStatus 📍3.0.2 FHIR Std.
CommunicationRequest.​category Base example CommunicationCategory 📍3.0.2 FHIR Std.
CommunicationRequest.​priority Base required RequestPriority 📍3.0.2 FHIR Std.
CommunicationRequest.​medium Base example v3 Code System ParticipationMode 📍2016-11-11 FHIR Std.
CommunicationRequest.​reasonCode Base example v3 Code System ActReason 📍2016-11-11 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmr-1 error CommunicationRequest.requester onBehalfOf can only be specified if agent is practitioner or device (agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not()
dom-1 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CommunicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error CommunicationRequest 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusReason 0..1 CodeableConcept R5: Reason for current status (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.statusReason
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:intent ?! 1..1 code R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.intent
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
.... modifierExtension:doNotPerform ?! 0..1 boolean R5: True if request is prohibiting action (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.doNotPerform

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​status Base required RequestStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CommunicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error CommunicationRequest 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusReason 0..1 CodeableConcept R5: Reason for current status (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.statusReason
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:intent 1..1 code R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.intent
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
.... modifierExtension:doNotPerform 0..1 boolean R5: True if request is prohibiting action (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.doNotPerform
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: basedOn additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:replaces 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: replaces additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... recipient
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:recipient 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who to share the information with
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... topic
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:about 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Resources that pertain to this communication request additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... context
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The Encounter during which this CommunicationRequest was created additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... payload
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 CodeableConcept R5: content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content
.... contentReference
..... Slices for extension Content/Rules for all slices
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... sender
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:informationProvider 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who should share the information
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... requester
.... agent
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:requester 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who asks for the information to be shared
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusReason 0..1 CodeableConcept R5: Reason for current status (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.statusReason
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:intent ?! 1..1 code R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.intent
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
.... modifierExtension:doNotPerform ?! 0..1 boolean R5: True if request is prohibiting action (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.doNotPerform
... identifier Σ 0..* Identifier Unique identifier
... basedOn Σ 0..* Reference(Resource) Fulfills plan or proposal
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: basedOn additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:replaces 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: replaces additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code draft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
... priority Σ 0..1 code Message urgency
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
... medium 0..* CodeableConcept ​A channel of communication
Binding: ParticipationMode|2016-11-11 (example): Codes for communication mediums such as phone, fax, email, in person, etc.
... subject 0..1 Reference(Patient | Group) Focus of message
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... recipient 0..* Reference(Device | Organization | Patient | Practitioner | RelatedPerson | Group | CareTeam) Message recipient
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:recipient 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who to share the information with
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... topic 0..* Reference(Resource) Focal resources
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:about 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Resources that pertain to this communication request additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode leading to message
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: The Encounter during which this CommunicationRequest was created additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... payload 0..* BackboneElement Message payload
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:content 0..1 CodeableConcept R5: content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-CommunicationRequest.payload.content
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... content[x] 1..1 Message part content
..... content[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... occurrence[x] Σ 0..1 When scheduled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... authoredOn Σ 0..1 dateTime When request transitioned to being actionable
... sender 0..1 Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Message sender
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:informationProvider 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who should share the information
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... requester ΣC 0..1 BackboneElement Who/what is requesting service
Constraints: cmr-1
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... agent Σ 1..1 Reference(Practitioner | Organization | Patient | RelatedPerson | Device) Individual making the request
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:requester 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who asks for the information to be shared
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... onBehalfOf ΣC 0..1 Reference(Organization) Organization agent is acting for
... reasonCode Σ 0..* CodeableConcept ​Why is communication needed?
Binding: ActReason|2016-11-11 (example): Codes for describing reasons for the occurrence of a communication.
... reasonReference Σ 0..* Reference(Condition | Observation) Why is communication needed?
... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CommunicationRequest.​language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
CommunicationRequest.​status Base required RequestStatus 📍3.0.2 FHIR Std.
CommunicationRequest.​category Base example CommunicationCategory 📍3.0.2 FHIR Std.
CommunicationRequest.​priority Base required RequestPriority 📍3.0.2 FHIR Std.
CommunicationRequest.​medium Base example v3 Code System ParticipationMode 📍2016-11-11 FHIR Std.
CommunicationRequest.​reasonCode Base example v3 Code System ActReason 📍2016-11-11 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmr-1 error CommunicationRequest.requester onBehalfOf can only be specified if agent is practitioner or device (agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not()
dom-1 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CommunicationRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error CommunicationRequest 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron