Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4 - Downloaded Version null See the Directory of published versions
| 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_R4 | ||
This cross-version profile allows DSTU2 Communication content to be represented via FHIR R4 Communication resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Communication(4.0.1) | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
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 | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| 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().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(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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Communication(4.0.1) | A record of information transmitted from a sender to a receiver | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Meta | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | DSTU2: identifier additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: CommunicationRequest producing this message additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of this action | ||||
![]() ![]() |
0..* | Reference(Communication) | Reply to | |||||
![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (3.0.0) (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group) | Focus of message | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: Encounter leading to message additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | dateTime | When sent | |||||
![]() ![]() |
0..1 | dateTime | When received | |||||
![]() ![]() |
0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: recipient URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() |
0..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Attachment | DSTU2: content additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.payload.content Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() |
Content/Rules for all Types | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: content additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() |
0..* | Annotation | Comments made about the communication | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.meta.security | Base | extensible |
SecurityLabels
|
📍4.0.1 | tx.fhir.org |
| Communication.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.text.status | Base | required | NarrativeStatus | 📍4.0.1 | FHIR Std. |
| Communication.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Communication.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Communication.basedOn.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | example | CommunicationNotDoneReason | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| Communication.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Communication.medium | Base | example | ParticipationMode | 📍3.0.0 | THO v7.1 |
| Communication.subject.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.encounter.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.recipient.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.sender.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| 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().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(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.reasonCode, Communication.reasonReference, 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()
|
This structure is derived from Communication
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Communication(4.0.1) | A record of information transmitted from a sender to a receiver | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
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 | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| 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().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(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
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Communication(4.0.1) | A record of information transmitted from a sender to a receiver | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Meta | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | DSTU2: identifier additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Request fulfilled by this communication | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: CommunicationRequest producing this message additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | Part of this action | ||||
![]() ![]() |
0..* | Reference(Communication) | Reply to | |||||
![]() ![]() |
?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen. | ||||
![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | ||||
![]() ![]() |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (3.0.0) (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group) | Focus of message | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: Encounter leading to message additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | dateTime | When sent | |||||
![]() ![]() |
0..1 | dateTime | When received | |||||
![]() ![]() |
0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: recipient URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
![]() ![]() |
0..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Attachment | DSTU2: content additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Communication.payload.content Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | Message part content | ||||||
![]() ![]() ![]() ![]() |
Content/Rules for all Types | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | DSTU2: content additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() |
0..* | Annotation | Comments made about the communication | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.meta.security | Base | extensible |
SecurityLabels
|
📍4.0.1 | tx.fhir.org |
| Communication.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.text.status | Base | required | NarrativeStatus | 📍4.0.1 | FHIR Std. |
| Communication.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Communication.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Communication.basedOn.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | example | CommunicationNotDoneReason | 📍4.0.1 | FHIR Std. |
| Communication.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| Communication.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Communication.medium | Base | example | ParticipationMode | 📍3.0.0 | THO v7.1 |
| Communication.subject.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.encounter.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.recipient.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.sender.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Communication.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| 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().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(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.reasonCode, Communication.reasonReference, 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()
|
This structure is derived from Communication
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron