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

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

Resource Profile: Profile_R2_Communication_R5

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

This cross-version profile allows DSTU2 Communication content to be represented via FHIR R5 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(5.0.0) A clinical or business level record of information being transmitted or shared
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code DSTU2: in-progress | completed | suspended | rejected | failed additional codes
URL: http://hl7.org/fhir/1.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 📍5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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.modifierExtension, 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.modifierExtension, 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(5.0.0) A clinical or business level record of information being transmitted or shared
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:requestDetail 0..1 Reference(Resource) DSTU2: CommunicationRequest producing this message 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 DSTU2: in-progress | completed | suspended | rejected | failed additional codes
URL: http://hl7.org/fhir/1.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) DSTU2: 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:encounter 0..1 Reference(Resource) DSTU2: Encounter 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) DSTU2: Message 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) DSTU2: Message sender
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 string, Attachment DSTU2: content additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.payload.content
.... contentReference
..... Slices for extension Content/Rules for all slices
...... extension:alternateReference 0..1 Reference(Resource) DSTU2: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication(5.0.0) A clinical or business level record of information being transmitted or shared
... 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 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.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: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
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 DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 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:requestDetail 0..1 Reference(Resource) DSTU2: CommunicationRequest producing this 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Resource) Part of referenced event (e.g. Communication, Procedure)
... 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 DSTU2: in-progress | completed | suspended | rejected | failed additional codes
URL: http://hl7.org/fhir/1.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) DSTU2: 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 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) The Encounter during which this Communication was created
.... 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:encounter 0..1 Reference(Resource) DSTU2: Encounter 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... sent 0..1 dateTime When sent
... received 0..1 dateTime When received
... recipient 0..* Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
.... 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) DSTU2: Message 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... sender 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam) Who shares the information
.... 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) DSTU2: Message 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... reason Σ 0..* CodeableReference(Resource) Indication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
... 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 string, Attachment DSTU2: content additional types
URL: http://hl7.org/fhir/1.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 string 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) DSTU2: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... contentCodeableConcept CodeableConcept
... note 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Communication.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Communication.language Base required All Languages 📍5.0.0 FHIR Std.
Communication.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Communication.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Communication.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Communication.basedOn.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.statusReason Base example Communication Not Done Reason 📍5.0.0 FHIR Std.
Communication.category Base example Communication Category 📍5.0.0 FHIR Std.
Communication.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Communication.medium Base example ParticipationMode 📍3.0.0 THO v7.1
Communication.subject.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.topic Base example Communication Topic 📍5.0.0 FHIR Std.
Communication.encounter.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.recipient.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.sender.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.reason Base example SNOMED CT Clinical Findings 📍5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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.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.modifierExtension, 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:requestDetail, Communication.basedOn.reference, Communication.basedOn.type, Communication.basedOn.identifier, Communication.basedOn.display, Communication.partOf, 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:encounter, 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.reason, 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 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.modifierExtension, Communication.identifier.extension, Communication.identifier.extension:identifier, Communication.basedOn.extension, Communication.basedOn.extension:requestDetail, Communication.status.extension, Communication.status.extension:status, Communication.subject.extension, Communication.subject.extension:subject, Communication.encounter.extension, Communication.encounter.extension:encounter, Communication.recipient.extension, Communication.recipient.extension:recipient, Communication.sender.extension, Communication.sender.extension:sender, Communication.payload.extension, Communication.payload.extension:content, Communication.payload.modifierExtension, Communication.payload.content[x].extension, Communication.payload.content[x].extension:alternateReference 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(5.0.0) A clinical or business level record of information being transmitted or shared
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code DSTU2: in-progress | completed | suspended | rejected | failed additional codes
URL: http://hl7.org/fhir/1.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 📍5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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.modifierExtension, 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.modifierExtension, 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(5.0.0) A clinical or business level record of information being transmitted or shared
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:requestDetail 0..1 Reference(Resource) DSTU2: CommunicationRequest producing this message 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 DSTU2: in-progress | completed | suspended | rejected | failed additional codes
URL: http://hl7.org/fhir/1.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) DSTU2: 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:encounter 0..1 Reference(Resource) DSTU2: Encounter 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) DSTU2: Message 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) DSTU2: Message sender
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 string, Attachment DSTU2: content additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.payload.content
.... contentReference
..... Slices for extension Content/Rules for all slices
...... extension:alternateReference 0..1 Reference(Resource) DSTU2: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication(5.0.0) A clinical or business level record of information being transmitted or shared
... 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 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.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: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
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 DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 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:requestDetail 0..1 Reference(Resource) DSTU2: CommunicationRequest producing this 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Resource) Part of referenced event (e.g. Communication, Procedure)
... 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 DSTU2: in-progress | completed | suspended | rejected | failed additional codes
URL: http://hl7.org/fhir/1.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) DSTU2: 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 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) The Encounter during which this Communication was created
.... 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:encounter 0..1 Reference(Resource) DSTU2: Encounter 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... sent 0..1 dateTime When sent
... received 0..1 dateTime When received
... recipient 0..* Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
.... 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) DSTU2: Message 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... sender 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam) Who shares the information
.... 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) DSTU2: Message 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... reason Σ 0..* CodeableReference(Resource) Indication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
... 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 string, Attachment DSTU2: content additional types
URL: http://hl7.org/fhir/1.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 string 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) DSTU2: content additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... contentCodeableConcept CodeableConcept
... note 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Communication.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Communication.language Base required All Languages 📍5.0.0 FHIR Std.
Communication.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Communication.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Communication.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Communication.basedOn.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.statusReason Base example Communication Not Done Reason 📍5.0.0 FHIR Std.
Communication.category Base example Communication Category 📍5.0.0 FHIR Std.
Communication.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Communication.medium Base example ParticipationMode 📍3.0.0 THO v7.1
Communication.subject.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.topic Base example Communication Topic 📍5.0.0 FHIR Std.
Communication.encounter.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.recipient.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.sender.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Communication.reason Base example SNOMED CT Clinical Findings 📍5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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.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.modifierExtension, 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:requestDetail, Communication.basedOn.reference, Communication.basedOn.type, Communication.basedOn.identifier, Communication.basedOn.display, Communication.partOf, 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:encounter, 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.reason, 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 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.modifierExtension, Communication.identifier.extension, Communication.identifier.extension:identifier, Communication.basedOn.extension, Communication.basedOn.extension:requestDetail, Communication.status.extension, Communication.status.extension:status, Communication.subject.extension, Communication.subject.extension:subject, Communication.encounter.extension, Communication.encounter.extension:encounter, Communication.recipient.extension, Communication.recipient.extension:recipient, Communication.sender.extension, Communication.sender.extension:sender, Communication.payload.extension, Communication.payload.extension:content, Communication.payload.modifierExtension, Communication.payload.content[x].extension, Communication.payload.content[x].extension:alternateReference 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