FHIR Implementation Guide for HCX
0.9.0 - CI Build
FHIR Implementation Guide for HCX
0.9.0 - CI Build
FHIR Implementation Guide for HCX - Local Development build (v0.9.0). See the Directory of published versions
| Defining URL: | https://ig.hcxprotocol.io/v0.9/StructureDefinition-Communication.html |
| Version: | 0.9.0 |
| Name: | Communication |
| Status: | Draft as of 2019-11-01 09:29:23+1100 (Standards Status: Trial Use) |
| Definition: | An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition. |
| Publisher: | HCX Open Community |
| Maturity: | 0 |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://ig.hcxprotocol.io/v0.9/StructureDefinition-Communication.html
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Communication
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
  identifier | Σ | 1..* | Identifier | Unique identifier |
 inResponseTo | 0..* | Reference(Communication) | Reply to | |
| subject | Σ | 0..1 | Reference(Patient | Group) | Focus of message |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
| recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |
| sender | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |
| reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: CommunicationReasonCodes (example): Codes for describing reasons for the occurrence of a communication. |
 reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..* | Identifier | Unique identifier | ||||
| 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 | ||||
| partOf | Σ | 0..* | Reference(Resource) | Part of this action | ||||
| 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. | ||||
| 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 (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
| subject | Σ | 0..1 | Reference(Patient | Group) | Focus of message | ||||
| topic | 0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
| about | 0..* | Reference(Resource) | Resources that pertain to this communication | |||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| sent | 0..1 | dateTime | When sent | |||||
| received | 0..1 | dateTime | When received | |||||
| recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| sender | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
| reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: CommunicationReasonCodes (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
 payload | 0..* | BackboneElement | Message payload | |||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
  content[x] | 1..1 | Message part content | ||||||
 contentString | string | |||||||
| contentAttachment | Attachment | |||||||
| contentReference | Reference(Resource) | |||||||
| note | 0..* | Annotation | Comments made about the communication | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
| Documentation for this format | ||||
This structure is derived from Communication
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |
| identifier | Σ | 1..* | Identifier | Unique identifier |
| inResponseTo | 0..* | Reference(Communication) | Reply to | |
| subject | Σ | 0..1 | Reference(Patient | Group) | Focus of message |
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
| recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |
| sender | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |
| reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: CommunicationReasonCodes (example): Codes for describing reasons for the occurrence of a communication. |
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Communication | 0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..* | Identifier | Unique identifier | ||||
| 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 | ||||
| partOf | Σ | 0..* | Reference(Resource) | Part of this action | ||||
| 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. | ||||
| 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 (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
| subject | Σ | 0..1 | Reference(Patient | Group) | Focus of message | ||||
| topic | 0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
| about | 0..* | Reference(Resource) | Resources that pertain to this communication | |||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| sent | 0..1 | dateTime | When sent | |||||
| received | 0..1 | dateTime | When received | |||||
| recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| sender | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
| reasonCode | Σ | 0..* | CodeableConcept | Indication for message Binding: CommunicationReasonCodes (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | ||||
| payload | 0..* | BackboneElement | Message payload | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| content[x] | 1..1 | Message part content | ||||||
| contentString | string | |||||||
| contentAttachment | Attachment | |||||||
| contentReference | Reference(Resource) | |||||||
| note | 0..* | Annotation | Comments made about the communication | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | ||||
| Communication.language | preferred | CommonLanguages
| ||||
| Communication.status | required | EventStatus | ||||
| Communication.statusReason | example | CommunicationNotDoneReason | ||||
| Communication.category | example | CommunicationCategory | ||||
| Communication.priority | required | RequestPriority | ||||
| Communication.medium | example | ParticipationMode | ||||
| Communication.topic | example | CommunicationTopic | ||||
| Communication.reasonCode | example | CommunicationReasonCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |