abstractbaseDefinitioncopyrightdescription- Values Differ
experimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurl| Left: | AU eRequesting CommunicationRequest Patient (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest-patient) |
| Right: | AU eRequesting CommunicationRequest Patient (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest-patient) |
| Information | CommunicationRequest.language | Example/preferred bindings differ at CommunicationRequest.language using binding from AUeRequestingCommunicationRequestPatient |
| Information | StructureDefinition.short | Values for short differ: 'Date/time communication request direction obtained' vs 'When request transitioned to being actionable' |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest | ||
| copyright | Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. | ||
| description | This profile sets the minimum expectations for a CommunicationRequest resource used to represent a request for direct communication from a diagnostic provider (Filler) to a patient. It supports use cases where the diagnostic provider may communicate with the patient, for example, to suggest booking an appointment or to provide instructions for a diagnostic test. It also supports requests for communication not to be performed, for example, when a patient has requested that they not be contacted by SMS. Supported communication mediums include SMS and email. It is based on the [AU eRequesting CommunicationRequest](StructureDefinition-au-erequesting-communicationrequest.html) and identifies the additional constraints, extensions, vocabularies and value sets that **SHALL** be present in the CommunicationRequest when conforming to this profile. | This profile sets the minimum expectations for a CommunicationRequest resource used to represent a request for direct communication from a diagnostic provider (filler) to a patient. It is based on the [AU eRequesting CommunicationRequest](StructureDefinition-au-erequesting-communicationrequest.html) profile and identifies the additional constraints, extensions, vocabularies and value sets that **SHALL** be present in the CommunicationRequest when conforming to this profile. |
|
| experimental | |||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#AU | ||
| kind | resource | ||
| name | AUeRequestingCommunicationRequestPatient | ||
| publisher | HL7 Australia | ||
| purpose | |||
| status | active | ||
| title | AU eRequesting CommunicationRequest Patient | ||
| type | CommunicationRequest | ||
| url | http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest-patient | ||
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 CommunicationRequest | 0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver | 0..* | AUeRequestingCommunicationRequest | A request for information to be sent to a receiver | |||||||||||||||||||||||||||
 id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||||||||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||||||||||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||
| language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
|
| ||||||||||||||||||||||||||
| 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 | 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 | |||||||||||||||||||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||||||||||||||||||
 extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||
| identifier | Σ | 0..* | Identifier | Unique identifier | Σ | 0..* | Identifier | Unique identifier | |||||||||||||||||||||||||
| basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | |||||||||||||||||||||||||
| replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | |||||||||||||||||||||||||
 groupIdentifier | SOΣ | 1..1 | ?? | Composite request this is part of
| SOΣ | 1..1 | ?? | Composite request this is part of | |||||||||||||||||||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||||||||||||||||||
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: ?? (required) | Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: ?? (required) | |||||||||||||||||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"PGN"} | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"PGN"} | |||||||||||||||||||||||||
| text | Σ | 0..1 | string | Plain text representation of the concept | Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||
| system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | |||||||||||||||||||||||||
| value | Σ | 1..1 | string | Order identifier Example General: 123456 | Σ | 1..1 | string | Order identifier Example General: 123456 | |||||||||||||||||||||||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 0..1 | Period | Time period when id is/was valid for use | |||||||||||||||||||||||||
 assigner | Σ | 0..1 | Reference(Organization) | Organisation that assigned the order identifier | Σ | 0..1 | Reference(Organization) | Organisation that assigned the order identifier | |||||||||||||||||||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | |||||||||||||||||||||||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||||||||||||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||||||||||
| display | Σ | 1..1 | string | Name of the assigning organisation | Σ | 1..1 | string | Name of the assigning organisation | |||||||||||||||||||||||||
| status | ?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: ?? (required): The status of the communication request. Fixed Value: active
| ?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: ?? (required): The status of the communication request. Fixed Value: active | |||||||||||||||||||||||||
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | |||||||||||||||||||||||||||
| category | SO | 1..* | CodeableConcept | Message category Binding: ?? (required)
| SO | 1..* | CodeableConcept | Message category Binding: ?? (required) | |||||||||||||||||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | Σ | 1..1 | Coding | Code defined by a terminology system | |||||||||||||||||||||||||
| text | Σ | 0..1 | string | Plain text representation of the concept | Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: ?? (required): Codes indicating the relative importance of a communication request. | Σ | 0..1 | code | routine | urgent | asap | stat Binding: ?? (required): Codes indicating the relative importance of a communication request. | |||||||||||||||||||||||||
| doNotPerform | ?!SOΣ | 0..1 | boolean | Set to true when SMS or email communication with the patient is not to be performed
| ?!SOΣ | 0..1 | boolean | Set to true when SMS or email communication with the patient is not to be performed
| |||||||||||||||||||||||||
| medium | SO | 1..* | CodeableConcept | A channel of communication Binding: ?? (required)
| SO | 1..* | CodeableConcept | A channel of communication Binding: ?? (required)
| |||||||||||||||||||||||||
| subject | SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the communication request
| SO | 1..1 | Reference(AU Core Patient) | Patient that is the subject of the communication request | |||||||||||||||||||||||||
| about | SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) | Fulfilment task group or diagnostic request the communication is about
| SO | 1..* | Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) | Fulfilment task group or diagnostic request the communication is about | |||||||||||||||||||||||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | |||||||||||||||||||||||||
| payload | 0..* | BackboneElement | Message payload | 0..* | BackboneElement | Message payload | |||||||||||||||||||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||
| content[x] | 1..1 | string, Attachment, Reference(Resource) | Message part content | 1..1 | string, Attachment, Reference(Resource) | Message part content | |||||||||||||||||||||||||||
| occurrence[x] | Σ | 0..1 | dateTime, Period | When scheduled | Σ | 0..1 | dateTime, Period | When scheduled | |||||||||||||||||||||||||
| authoredOn | SOΣ | 1..1 | dateTime | Date/time communication request direction obtained
| SOΣ | 1..1 | dateTime | When request transitioned to being actionable | |||||||||||||||||||||||||
| requester | SOΣ | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) | Patient, provider or practice requesting the communication (or requesting it not be performed)
| SOΣ | 1..1 | Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) | Patient, provider or practice requesting the communication (or requesting it not be performed) | |||||||||||||||||||||||||
| recipient | SO | 1..1 | Reference(AU Core Patient) | Patient receiving the communication
| SO | 1..1 | Reference(AU Core Patient) | Patient receiving the communication | |||||||||||||||||||||||||
| sender | SOΣ | 0..1 | Reference(AU Core Organization) | Organisation sending the communication
| SOΣ | 0..1 | Reference(AU Core Organization) | Organisation sending the communication | |||||||||||||||||||||||||
| reasonCode | SOΣ | 1..1 | CodeableConcept | Why is communication needed? Binding: ?? (required)
| SOΣ | 1..1 | CodeableConcept | Why is communication needed? Binding: ?? (required) | |||||||||||||||||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason","code":"patient"} | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: {"system":"http://terminology.hl7.org.au/CodeSystem/communicationrequest-reason","code":"patient"} | |||||||||||||||||||||||||
| text | Σ | 0..1 | string | Plain text representation of the concept | Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | |||||||||||||||||||||||||
| note | 0..* | Annotation | Comments made about communication request | 0..* | Annotation | Comments made about communication request | |||||||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||||||||||