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

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

Resource Profile: Profile_R3_Communication_R4B

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Communication Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_Communication_R4B

This cross-version profile allows STU3 Communication content to be represented via FHIR R4B Communication 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
.. Communication 0..* Communication(4.3.0) A record of information transmitted from a sender 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
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.definition
Constraints: ext-1
.... extension:notDoneReason 0..1 CodeableConcept STU3: Why communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDoneReason
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
Constraints: ext-1
.... extension:topic 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) STU3: Focal resources (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.topic
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:notDone ?! 0..1 boolean STU3: Communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDone
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code STU3: preparation | in-progress | suspended | aborted | completed | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.status
Binding: EventStatus (required): The status of the communication.
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Communication 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()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error Communication.implicitRules, Communication.extension, Communication.extension:definition, Communication.extension:notDoneReason, Communication.extension:topic, Communication.modifierExtension, Communication.modifierExtension:notDone, Communication.status, Communication.status.extension, Communication.status.extension:status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Communication.extension, Communication.extension:definition, Communication.extension:notDoneReason, Communication.extension:topic, Communication.modifierExtension, Communication.modifierExtension:notDone, Communication.status.extension, Communication.status.extension:status Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication(4.3.0) A record of information transmitted from a sender to a receiver
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.definition
.... extension:notDoneReason 0..1 CodeableConcept STU3: Why communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDoneReason
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
.... extension:topic 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) STU3: Focal resources (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.topic
.... modifierExtension:notDone 0..1 boolean STU3: Communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDone
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.identifier
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* Reference(Resource) STU3: basedOn additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..* Reference(Resource) STU3: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code STU3: preparation | in-progress | suspended | aborted | completed | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.status
Binding: EventStatus (required): The status of the communication.
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) STU3: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..1 Reference(Resource) STU3: Encounter or episode leading to message 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..* Reference(Resource) STU3: recipient
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... sender
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:sender 0..1 Reference(Resource) STU3: sender
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... reasonReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:reasonReference 0..* Reference(Resource) STU3: reasonReference 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 Attachment STU3: content additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.payload.content
.... contentReference
..... Slices for extension Content/Rules for all slices
...... extension:alternateReference 0..1 Reference(Resource) STU3: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.note

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication(4.3.0) A record of information transmitted from a sender to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.meta
Constraints: ext-1
.... 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)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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): IETF language tag
Additional BindingsPurpose
AllLanguages 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.definition
Constraints: ext-1
.... extension:notDoneReason 0..1 CodeableConcept STU3: Why communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDoneReason
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
Constraints: ext-1
.... extension:topic 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) STU3: Focal resources (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.topic
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:notDone ?! 0..1 boolean STU3: Communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDone
Constraints: ext-1
... identifier Σ 0..* Identifier Unique identifier
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(Resource) Request fulfilled by this communication
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:basedOn 0..1 Reference(Resource) STU3: basedOn additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Resource) Part of this action
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:partOf 0..1 Reference(Resource) STU3: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... inResponseTo 0..* Reference(Communication) Reply to
... status ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code STU3: preparation | in-progress | suspended | aborted | completed | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.status
Binding: EventStatus (required): The status of the communication.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium 0..* CodeableConcept A channel of communication
Binding: ParticipationMode (3.0.0) (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 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) STU3: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... topic 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
... about 0..* Reference(Resource) Resources that pertain to this communication
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..1 Reference(Resource) STU3: Encounter or episode leading to message additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... sent 0..1 dateTime When sent
... received 0..1 dateTime When received
... recipient 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) Message recipient
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:recipient 0..1 Reference(Resource) STU3: recipient
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... sender 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:sender 0..1 Reference(Resource) STU3: sender
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reasonCode Σ 0..* CodeableConcept Indication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why was communication done?
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:reasonReference 0..1 Reference(Resource) STU3: reasonReference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... 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 Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:content 0..1 Attachment STU3: content additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.payload.content
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... content[x] 1..1 Message part content
..... content[x]All Types Content/Rules for all Types
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:alternateReference 0..1 Reference(Resource) STU3: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... note 0..* Annotation Comments made about the communication
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Communication.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Communication.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Communication.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Communication.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Communication.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Communication.basedOn.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.partOf.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.status Base required EventStatus 📍4.3.0 FHIR Std.
Communication.statusReason Base example CommunicationNotDoneReason 📍4.3.0 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.3.0 FHIR Std.
Communication.priority Base required RequestPriority 📍4.3.0 FHIR Std.
Communication.medium Base example ParticipationMode 📍3.0.0 THO v7.1
Communication.subject.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.topic Base example CommunicationTopic 📍4.3.0 FHIR Std.
Communication.encounter.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.recipient.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.sender.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.reasonCode Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
Communication.reasonReference.​type Base extensible ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Communication 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()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning Communication.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Communication.meta, Communication.meta.extension, Communication.meta.extension:meta, Communication.meta.versionId, Communication.meta.lastUpdated, Communication.meta.source, Communication.meta.profile, Communication.meta.security, Communication.meta.tag, Communication.implicitRules, Communication.language, Communication.text, Communication.text.extension, Communication.text.extension:text, Communication.text.status, Communication.text.div, Communication.extension, Communication.extension:definition, Communication.extension:notDoneReason, Communication.extension:topic, Communication.modifierExtension, Communication.modifierExtension:notDone, Communication.identifier, Communication.identifier.extension, Communication.identifier.extension:identifier, Communication.identifier.use, Communication.identifier.type, Communication.identifier.system, Communication.identifier.value, Communication.identifier.period, Communication.identifier.assigner, Communication.instantiatesCanonical, Communication.instantiatesUri, Communication.basedOn, Communication.basedOn.extension, Communication.basedOn.extension:basedOn, Communication.basedOn.reference, Communication.basedOn.type, Communication.basedOn.identifier, Communication.basedOn.display, Communication.partOf, Communication.partOf.extension, Communication.partOf.extension:partOf, Communication.partOf.reference, Communication.partOf.type, Communication.partOf.identifier, Communication.partOf.display, Communication.inResponseTo, Communication.status, Communication.status.extension, Communication.status.extension:status, Communication.statusReason, Communication.category, Communication.priority, Communication.medium, Communication.subject, Communication.subject.extension, Communication.subject.extension:subject, Communication.subject.reference, Communication.subject.type, Communication.subject.identifier, Communication.subject.display, Communication.topic, Communication.about, Communication.encounter, Communication.encounter.extension, Communication.encounter.extension:context, Communication.encounter.reference, Communication.encounter.type, Communication.encounter.identifier, Communication.encounter.display, Communication.sent, Communication.received, Communication.recipient, Communication.recipient.extension, Communication.recipient.extension:recipient, Communication.recipient.reference, Communication.recipient.type, Communication.recipient.identifier, Communication.recipient.display, Communication.sender, Communication.sender.extension, Communication.sender.extension:sender, Communication.sender.reference, Communication.sender.type, Communication.sender.identifier, Communication.sender.display, Communication.reasonCode, Communication.reasonReference, Communication.reasonReference.extension, Communication.reasonReference.extension:reasonReference, Communication.reasonReference.reference, Communication.reasonReference.type, Communication.reasonReference.identifier, Communication.reasonReference.display, Communication.payload, Communication.payload.extension, Communication.payload.extension:content, Communication.payload.modifierExtension, Communication.payload.content[x], Communication.payload.content[x].extension, Communication.payload.content[x].extension:alternateReference, Communication.note, Communication.note.extension, Communication.note.extension:note, Communication.note.author[x], Communication.note.time, Communication.note.text All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Communication.meta.extension, Communication.meta.extension:meta, Communication.text.extension, Communication.text.extension:text, Communication.extension, Communication.extension:definition, Communication.extension:notDoneReason, Communication.extension:topic, Communication.modifierExtension, Communication.modifierExtension:notDone, Communication.identifier.extension, Communication.identifier.extension:identifier, Communication.basedOn.extension, Communication.basedOn.extension:basedOn, Communication.partOf.extension, Communication.partOf.extension:partOf, Communication.status.extension, Communication.status.extension:status, Communication.subject.extension, Communication.subject.extension:subject, Communication.encounter.extension, Communication.encounter.extension:context, Communication.recipient.extension, Communication.recipient.extension:recipient, Communication.sender.extension, Communication.sender.extension:sender, Communication.reasonReference.extension, Communication.reasonReference.extension:reasonReference, Communication.payload.extension, Communication.payload.extension:content, Communication.payload.modifierExtension, Communication.payload.content[x].extension, Communication.payload.content[x].extension:alternateReference, Communication.note.extension, Communication.note.extension:note Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Communication.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Communication.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication(4.3.0) A record of information transmitted from a sender 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
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.definition
Constraints: ext-1
.... extension:notDoneReason 0..1 CodeableConcept STU3: Why communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDoneReason
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
Constraints: ext-1
.... extension:topic 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) STU3: Focal resources (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.topic
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:notDone ?! 0..1 boolean STU3: Communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDone
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code STU3: preparation | in-progress | suspended | aborted | completed | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.status
Binding: EventStatus (required): The status of the communication.
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.status Base required EventStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Communication 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()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error Communication.implicitRules, Communication.extension, Communication.extension:definition, Communication.extension:notDoneReason, Communication.extension:topic, Communication.modifierExtension, Communication.modifierExtension:notDone, Communication.status, Communication.status.extension, Communication.status.extension:status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Communication.extension, Communication.extension:definition, Communication.extension:notDoneReason, Communication.extension:topic, Communication.modifierExtension, Communication.modifierExtension:notDone, Communication.status.extension, Communication.status.extension:status Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication(4.3.0) A record of information transmitted from a sender to a receiver
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.definition
.... extension:notDoneReason 0..1 CodeableConcept STU3: Why communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDoneReason
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
.... extension:topic 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) STU3: Focal resources (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.topic
.... modifierExtension:notDone 0..1 boolean STU3: Communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDone
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.identifier
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:basedOn 0..* Reference(Resource) STU3: basedOn additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..* Reference(Resource) STU3: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code STU3: preparation | in-progress | suspended | aborted | completed | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.status
Binding: EventStatus (required): The status of the communication.
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) STU3: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..1 Reference(Resource) STU3: Encounter or episode leading to message 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..* Reference(Resource) STU3: recipient
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... sender
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:sender 0..1 Reference(Resource) STU3: sender
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... reasonReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:reasonReference 0..* Reference(Resource) STU3: reasonReference 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 Attachment STU3: content additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.payload.content
.... contentReference
..... Slices for extension Content/Rules for all slices
...... extension:alternateReference 0..1 Reference(Resource) STU3: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.note

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication(4.3.0) A record of information transmitted from a sender to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.meta
Constraints: ext-1
.... 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)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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): IETF language tag
Additional BindingsPurpose
AllLanguages 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.definition
Constraints: ext-1
.... extension:notDoneReason 0..1 CodeableConcept STU3: Why communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDoneReason
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication was not done.
Constraints: ext-1
.... extension:topic 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) STU3: Focal resources (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.topic
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:notDone ?! 0..1 boolean STU3: Communication did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.notDone
Constraints: ext-1
... identifier Σ 0..* Identifier Unique identifier
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(Resource) Request fulfilled by this communication
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:basedOn 0..1 Reference(Resource) STU3: basedOn additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Resource) Part of this action
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:partOf 0..1 Reference(Resource) STU3: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... inResponseTo 0..* Reference(Communication) Reply to
... status ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code STU3: preparation | in-progress | suspended | aborted | completed | entered-in-error additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.status
Binding: EventStatus (required): The status of the communication.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... statusReason Σ 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium 0..* CodeableConcept A channel of communication
Binding: ParticipationMode (3.0.0) (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 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) STU3: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... topic 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
... about 0..* Reference(Resource) Resources that pertain to this communication
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..1 Reference(Resource) STU3: Encounter or episode leading to message additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... sent 0..1 dateTime When sent
... received 0..1 dateTime When received
... recipient 0..* Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) Message recipient
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:recipient 0..1 Reference(Resource) STU3: recipient
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... sender 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:sender 0..1 Reference(Resource) STU3: sender
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reasonCode Σ 0..* CodeableConcept Indication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why was communication done?
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:reasonReference 0..1 Reference(Resource) STU3: reasonReference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... 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 Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:content 0..1 Attachment STU3: content additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.payload.content
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... content[x] 1..1 Message part content
..... content[x]All Types Content/Rules for all Types
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:alternateReference 0..1 Reference(Resource) STU3: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
... note 0..* Annotation Comments made about the communication
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Communication.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Communication.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Communication.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Communication.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Communication.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Communication.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Communication.basedOn.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.partOf.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.status Base required EventStatus 📍4.3.0 FHIR Std.
Communication.statusReason Base example CommunicationNotDoneReason 📍4.3.0 FHIR Std.
Communication.category Base example CommunicationCategory 📍4.3.0 FHIR Std.
Communication.priority Base required RequestPriority 📍4.3.0 FHIR Std.
Communication.medium Base example ParticipationMode 📍3.0.0 THO v7.1
Communication.subject.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.topic Base example CommunicationTopic 📍4.3.0 FHIR Std.
Communication.encounter.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.recipient.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.sender.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Communication.reasonCode Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
Communication.reasonReference.​type Base extensible ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Communication 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()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning Communication.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Communication.meta, Communication.meta.extension, Communication.meta.extension:meta, Communication.meta.versionId, Communication.meta.lastUpdated, Communication.meta.source, Communication.meta.profile, Communication.meta.security, Communication.meta.tag, Communication.implicitRules, Communication.language, Communication.text, Communication.text.extension, Communication.text.extension:text, Communication.text.status, Communication.text.div, Communication.extension, Communication.extension:definition, Communication.extension:notDoneReason, Communication.extension:topic, Communication.modifierExtension, Communication.modifierExtension:notDone, Communication.identifier, Communication.identifier.extension, Communication.identifier.extension:identifier, Communication.identifier.use, Communication.identifier.type, Communication.identifier.system, Communication.identifier.value, Communication.identifier.period, Communication.identifier.assigner, Communication.instantiatesCanonical, Communication.instantiatesUri, Communication.basedOn, Communication.basedOn.extension, Communication.basedOn.extension:basedOn, Communication.basedOn.reference, Communication.basedOn.type, Communication.basedOn.identifier, Communication.basedOn.display, Communication.partOf, Communication.partOf.extension, Communication.partOf.extension:partOf, Communication.partOf.reference, Communication.partOf.type, Communication.partOf.identifier, Communication.partOf.display, Communication.inResponseTo, Communication.status, Communication.status.extension, Communication.status.extension:status, Communication.statusReason, Communication.category, Communication.priority, Communication.medium, Communication.subject, Communication.subject.extension, Communication.subject.extension:subject, Communication.subject.reference, Communication.subject.type, Communication.subject.identifier, Communication.subject.display, Communication.topic, Communication.about, Communication.encounter, Communication.encounter.extension, Communication.encounter.extension:context, Communication.encounter.reference, Communication.encounter.type, Communication.encounter.identifier, Communication.encounter.display, Communication.sent, Communication.received, Communication.recipient, Communication.recipient.extension, Communication.recipient.extension:recipient, Communication.recipient.reference, Communication.recipient.type, Communication.recipient.identifier, Communication.recipient.display, Communication.sender, Communication.sender.extension, Communication.sender.extension:sender, Communication.sender.reference, Communication.sender.type, Communication.sender.identifier, Communication.sender.display, Communication.reasonCode, Communication.reasonReference, Communication.reasonReference.extension, Communication.reasonReference.extension:reasonReference, Communication.reasonReference.reference, Communication.reasonReference.type, Communication.reasonReference.identifier, Communication.reasonReference.display, Communication.payload, Communication.payload.extension, Communication.payload.extension:content, Communication.payload.modifierExtension, Communication.payload.content[x], Communication.payload.content[x].extension, Communication.payload.content[x].extension:alternateReference, Communication.note, Communication.note.extension, Communication.note.extension:note, Communication.note.author[x], Communication.note.time, Communication.note.text All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Communication.meta.extension, Communication.meta.extension:meta, Communication.text.extension, Communication.text.extension:text, Communication.extension, Communication.extension:definition, Communication.extension:notDoneReason, Communication.extension:topic, Communication.modifierExtension, Communication.modifierExtension:notDone, Communication.identifier.extension, Communication.identifier.extension:identifier, Communication.basedOn.extension, Communication.basedOn.extension:basedOn, Communication.partOf.extension, Communication.partOf.extension:partOf, Communication.status.extension, Communication.status.extension:status, Communication.subject.extension, Communication.subject.extension:subject, Communication.encounter.extension, Communication.encounter.extension:context, Communication.recipient.extension, Communication.recipient.extension:recipient, Communication.sender.extension, Communication.sender.extension:sender, Communication.reasonReference.extension, Communication.reasonReference.extension:reasonReference, Communication.payload.extension, Communication.payload.extension:content, Communication.payload.modifierExtension, Communication.payload.content[x].extension, Communication.payload.content[x].extension:alternateReference, Communication.note.extension, Communication.note.extension:note Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Communication.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Communication.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron