IL Core Implementation Guide
0.18.0 - draft
IL Core Implementation Guide
0.18.0 - draft
This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-communication-request | Version: 0.18.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: ILCoreCommunicationRequest | ||
Israel Core proposed constraints and extensions on the CommunicationRequest Resource
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CommunicationRequest
| Path | Conformance | ValueSet | URI |
| CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  CommunicationRequest |
0..* | CommunicationRequest | ILCore CommunicationRequest Profile | |||||
  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 |
Σ | 0..* | Identifier | Unique identifier | ||||
 basedOn |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
| replaces |
Σ | 0..* | Reference(ILCore CommunicationRequest Profile) | 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(ILCore Patient Profile | ILCore Group Profile) | Focus of message | |||||
| about |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
| encounter |
Σ | 0..1 | Reference(ILCore Encounter Profile) | 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(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore RelatedPerson Profile | ILCore Device Profile) | Who/what is requesting service | ||||
| recipient |
0..* | Reference(ILCore Device Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore RelatedPerson Profile | ILCore Group Profile | ILCore CareTeam Profile | ILCore HealthcareService Profile) | Message recipient | |||||
| sender |
Σ | 0..1 | Reference(ILCore Device Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore RelatedPerson Profile | ILCore HealthcareService Profile) | Message sender | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference |
Σ | 0..* | Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | Why is communication needed? | ||||
| note |
0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CommunicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| CommunicationRequest.statusReason | example | |||||
| CommunicationRequest.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | ||||
| CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
| CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
This structure is derived from CommunicationRequest
Summary
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from CommunicationRequest
Key Elements View
| Path | Conformance | ValueSet | URI |
| CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest | ILCore CommunicationRequest Profile | |||||
| 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 |
Σ | 0..* | Identifier | Unique identifier | ||||
| basedOn |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
| replaces |
Σ | 0..* | Reference(ILCore CommunicationRequest Profile) | 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(ILCore Patient Profile | ILCore Group Profile) | Focus of message | |||||
| about |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
| encounter |
Σ | 0..1 | Reference(ILCore Encounter Profile) | 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(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore RelatedPerson Profile | ILCore Device Profile) | Who/what is requesting service | ||||
| recipient |
0..* | Reference(ILCore Device Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore RelatedPerson Profile | ILCore Group Profile | ILCore CareTeam Profile | ILCore HealthcareService Profile) | Message recipient | |||||
| sender |
Σ | 0..1 | Reference(ILCore Device Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore RelatedPerson Profile | ILCore HealthcareService Profile) | Message sender | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference |
Σ | 0..* | Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | Why is communication needed? | ||||
| note |
0..* | Annotation | Comments made about communication request | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| CommunicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| CommunicationRequest.statusReason | example | |||||
| CommunicationRequest.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-categoryfrom the FHIR Standard | ||||
| CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| CommunicationRequest.medium | example | ParticipationModehttp://terminology.hl7.org/ValueSet/v3-ParticipationMode | ||||
| CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
This structure is derived from CommunicationRequest
Summary
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron