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-CommunicationRequest.html |
| Version: | 0.9.0 |
| Name: | CommunicationRequest |
| Status: | Draft as of 2019-11-01 09:29:23+1100 (Standards Status: Trial Use) |
| Definition: | A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be 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-CommunicationRequest.html
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CommunicationRequest
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
This structure is derived from CommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
  id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: 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 | ||||
 basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
| replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
| groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request. | |||||
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
| doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
| 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 | |||||
| about | 0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
 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) | |||||||
| occurrence[x] | Σ | 0..1 | When scheduled | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| authoredOn | Σ | 0..1 | dateTime | When request transitioned to being actionable | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| 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 | Why is communication needed? Binding: CommunicationReasonCodes (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
| note | 0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |
| Documentation for this format | ||||
This structure is derived from CommunicationRequest
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from CommunicationRequest
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CommunicationRequest | 0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: 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 | ||||
| basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
| replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
| groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a request. | |||||
| category | 0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
| doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
| 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 | |||||
| about | 0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| 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) | |||||||
| occurrence[x] | Σ | 0..1 | When scheduled | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| authoredOn | Σ | 0..1 | dateTime | When request transitioned to being actionable | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| 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 | Why is communication needed? Binding: CommunicationReasonCodes (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
| note | 0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | ||||
| CommunicationRequest.language | preferred | CommonLanguages
| ||||
| CommunicationRequest.status | required | RequestStatus | ||||
| CommunicationRequest.statusReason | example | |||||
| CommunicationRequest.category | example | CommunicationCategory | ||||
| CommunicationRequest.priority | required | RequestPriority | ||||
| CommunicationRequest.medium | example | ParticipationMode | ||||
| CommunicationRequest.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() |