AU eRequesting Implementation Guide
1.0.0-ci-build - CI Build Australia flag

AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. See the Directory of published versions

Resource Profile: AU eRequesting CommunicationRequest ( Abstract )

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-communicationrequest Version: 1.0.0-ci-build
Standards status: Draft Maturity Level: 1 Computable Name: AUeRequestingCommunicationRequest

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for CommunicationRequest resources that are used to record, search, and fetch information about a communication request to be performed. It is based on the CommunicationRequest resource and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the CommunicationRequest when conforming to this profile.

Profile Specific Implementation Guidance

  • This abstract profile provides a shared base that is common across communication requests. It is not intended for direct implementation. Where a CommunicationRequest profile is defined for a specific purpose that profile SHALL be used:

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 1.0.0-ballot:

  • The resource metadata has changed (description)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed
  • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    This structure is derived from CommunicationRequest

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. CommunicationRequest 0..* CommunicationRequest This is an abstract profile. Child profiles: AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestPatient, AUeRequestingCommunicationRequestUrgentProvider
    A request for information to be sent to a receiver
    ... groupIdentifier SO 1..1 AULocalOrderIdentifier Composite request this is part of
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... type
    ..... coding 1..1 Coding Code defined by a terminology system
    Required Pattern: At least the following
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: PGN
    ... status SO 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    Fixed Value: active
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... category SO 1..* CodeableConcept Message category
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... about SO 1..* Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) Resources that pertain to this communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... authoredOn SO 1..1 dateTime When request transitioned to being actionable
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... requester SO 1..1 Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) Provider, Patient, or Organisation requesting the communication
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... recipient SO 1..1 Reference(AU Core PractitionerRole | AU Core Patient) Message recipient
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... sender SO 0..1 Reference(AU Core Organization) Organisation sending the communication
    ObligationsActor
    SHALL:populate-if-known AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... reasonCode SO 1..1 CodeableConcept Why is communication needed?
    Binding: AU eRequesting CommunicationRequest Reason (required)
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    CommunicationRequest.​reasonCode Base required AU eRequesting CommunicationRequest Reason 📦1.0.0-ci-build This IG
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. CommunicationRequest 0..* CommunicationRequest This is an abstract profile. Child profiles: AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestPatient, AUeRequestingCommunicationRequestUrgentProvider
    A request for information to be sent to a receiver
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... groupIdentifier SOΣ 1..1 AULocalOrderIdentifier Composite request this is part of
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    .... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
    Binding: Order Identifier Type (required)
    ..... coding Σ 1..1 Coding Code defined by a terminology system

    Required Pattern: At least the following
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ...... version 0..1 string Version of the system - if relevant
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: PGN
    ...... display 0..1 string Representation defined by the system
    ...... userSelected 0..1 boolean If this coding was chosen directly by the user
    .... system Σ 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
    ... category SO 1..* CodeableConcept Message category
    Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
    ... subject SO 1..1 Reference(AU Core Patient) Patient that is the subject of the communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... about SO 1..* Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) Resources that pertain to this communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... authoredOn SOΣ 1..1 dateTime When request transitioned to being actionable
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... requester SOΣ 1..1 Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) Provider, Patient, or Organisation requesting the communication
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... recipient SO 1..1 Reference(AU Core PractitionerRole | AU Core Patient) Message recipient
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... sender SOΣ 0..1 Reference(AU Core Organization) Organisation sending the communication
    ObligationsActor
    SHALL:populate-if-known AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... reasonCode SOΣ 1..1 CodeableConcept Why is communication needed?
    Binding: AU eRequesting CommunicationRequest Reason (required)
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    CommunicationRequest.​groupIdentifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    CommunicationRequest.​groupIdentifier.type Base required Order Identifier Type 📦6.0.0-ci-build AU Base Implementation Guide vnull
    CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
    CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
    CommunicationRequest.​reasonCode Base required AU eRequesting CommunicationRequest Reason 📦1.0.0-ci-build This IG

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error CommunicationRequest 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 CommunicationRequest 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 CommunicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice CommunicationRequest A resource should have narrative for robust management text.`div`.exists()
    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()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. CommunicationRequest 0..* CommunicationRequest This is an abstract profile. Child profiles: AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestPatient, AUeRequestingCommunicationRequestUrgentProvider
    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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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
    ... 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(CommunicationRequest) Request(s) replaced by this request
    ... groupIdentifier SOΣ 1..1 AULocalOrderIdentifier Composite request this is part of
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 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: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    .... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
    Binding: Order Identifier Type (required)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 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: At least the following
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ...... version 0..1 string Version of the system - if relevant
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: PGN
    ...... display 0..1 string Representation defined by the system
    ...... userSelected 0..1 boolean If this coding was chosen directly by the user
    ..... text Σ 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
    .... value Σ 1..1 string Order identifier
    Example General: 123456
    .... period Σ 0..1 Period Time period when id is/was valid for use
    .... assigner Σ 0..1 Reference(Organization) Organisation that assigned the order identifier
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 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
    ..... type Σ 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).
    ..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
    ..... display Σ 1..1 string Name of the assigning organisation
    ... status ?!SOΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    Binding: RequestStatus (required): The status of the communication request.
    Fixed Value: active
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... statusReason 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: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... 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 SO 1..1 Reference(AU Core Patient) Patient that is the subject of the communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... about SO 1..* Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) Resources that pertain to this communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... 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 SOΣ 1..1 dateTime When request transitioned to being actionable
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... requester SOΣ 1..1 Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) Provider, Patient, or Organisation requesting the communication
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... recipient SO 1..1 Reference(AU Core PractitionerRole | AU Core Patient) Message recipient
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... sender SOΣ 0..1 Reference(AU Core Organization) Organisation sending the communication
    ObligationsActor
    SHALL:populate-if-known AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... reasonCode SOΣ 1..1 CodeableConcept Why is communication needed?
    Binding: AU eRequesting CommunicationRequest Reason (required)
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
    ... note 0..* Annotation Comments made about communication request

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    CommunicationRequest.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
    CommunicationRequest.​groupIdentifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    CommunicationRequest.​groupIdentifier.type Base required Order Identifier Type 📦6.0.0-ci-build AU Base Implementation Guide vnull
    CommunicationRequest.​groupIdentifier.assigner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
    CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
    CommunicationRequest.​statusReason Base example Not Stated Unknown
    CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
    CommunicationRequest.​priority Base required Request priority 📍4.0.1 FHIR Std.
    CommunicationRequest.​medium Base example ParticipationMode 📦3.0.0 THO v6.5
    CommunicationRequest.​reasonCode Base required AU eRequesting CommunicationRequest Reason 📦1.0.0-ci-build This IG

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error CommunicationRequest 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 CommunicationRequest 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 CommunicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice CommunicationRequest A resource should have narrative for robust management text.`div`.exists()
    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()

    Differential View

    This structure is derived from CommunicationRequest

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. CommunicationRequest 0..* CommunicationRequest This is an abstract profile. Child profiles: AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestPatient, AUeRequestingCommunicationRequestUrgentProvider
    A request for information to be sent to a receiver
    ... groupIdentifier SO 1..1 AULocalOrderIdentifier Composite request this is part of
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... type
    ..... coding 1..1 Coding Code defined by a terminology system
    Required Pattern: At least the following
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: PGN
    ... status SO 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    Fixed Value: active
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... category SO 1..* CodeableConcept Message category
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... about SO 1..* Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) Resources that pertain to this communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... authoredOn SO 1..1 dateTime When request transitioned to being actionable
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... requester SO 1..1 Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) Provider, Patient, or Organisation requesting the communication
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... recipient SO 1..1 Reference(AU Core PractitionerRole | AU Core Patient) Message recipient
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... sender SO 0..1 Reference(AU Core Organization) Organisation sending the communication
    ObligationsActor
    SHALL:populate-if-known AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... reasonCode SO 1..1 CodeableConcept Why is communication needed?
    Binding: AU eRequesting CommunicationRequest Reason (required)
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    CommunicationRequest.​reasonCode Base required AU eRequesting CommunicationRequest Reason 📦1.0.0-ci-build This IG

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. CommunicationRequest 0..* CommunicationRequest This is an abstract profile. Child profiles: AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestPatient, AUeRequestingCommunicationRequestUrgentProvider
    A request for information to be sent to a receiver
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... groupIdentifier SOΣ 1..1 AULocalOrderIdentifier Composite request this is part of
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    .... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
    Binding: Order Identifier Type (required)
    ..... coding Σ 1..1 Coding Code defined by a terminology system

    Required Pattern: At least the following
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ...... version 0..1 string Version of the system - if relevant
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: PGN
    ...... display 0..1 string Representation defined by the system
    ...... userSelected 0..1 boolean If this coding was chosen directly by the user
    .... system Σ 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
    ... category SO 1..* CodeableConcept Message category
    Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
    ... subject SO 1..1 Reference(AU Core Patient) Patient that is the subject of the communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... about SO 1..* Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) Resources that pertain to this communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... authoredOn SOΣ 1..1 dateTime When request transitioned to being actionable
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... requester SOΣ 1..1 Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) Provider, Patient, or Organisation requesting the communication
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... recipient SO 1..1 Reference(AU Core PractitionerRole | AU Core Patient) Message recipient
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... sender SOΣ 0..1 Reference(AU Core Organization) Organisation sending the communication
    ObligationsActor
    SHALL:populate-if-known AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... reasonCode SOΣ 1..1 CodeableConcept Why is communication needed?
    Binding: AU eRequesting CommunicationRequest Reason (required)
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    CommunicationRequest.​groupIdentifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    CommunicationRequest.​groupIdentifier.type Base required Order Identifier Type 📦6.0.0-ci-build AU Base Implementation Guide vnull
    CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
    CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
    CommunicationRequest.​reasonCode Base required AU eRequesting CommunicationRequest Reason 📦1.0.0-ci-build This IG

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error CommunicationRequest 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 CommunicationRequest 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 CommunicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice CommunicationRequest A resource should have narrative for robust management text.`div`.exists()
    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()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. CommunicationRequest 0..* CommunicationRequest This is an abstract profile. Child profiles: AUeRequestingCommunicationRequestCopyTo, AUeRequestingCommunicationRequestPatient, AUeRequestingCommunicationRequestUrgentProvider
    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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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
    ... 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(CommunicationRequest) Request(s) replaced by this request
    ... groupIdentifier SOΣ 1..1 AULocalOrderIdentifier Composite request this is part of
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 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: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    .... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
    Binding: Order Identifier Type (required)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 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: At least the following
    ...... id 0..1 string Unique id for inter-element referencing
    ...... extension 0..* Extension Additional content defined by implementations
    ...... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ...... version 0..1 string Version of the system - if relevant
    ...... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: PGN
    ...... display 0..1 string Representation defined by the system
    ...... userSelected 0..1 boolean If this coding was chosen directly by the user
    ..... text Σ 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
    .... value Σ 1..1 string Order identifier
    Example General: 123456
    .... period Σ 0..1 Period Time period when id is/was valid for use
    .... assigner Σ 0..1 Reference(Organization) Organisation that assigned the order identifier
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 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
    ..... type Σ 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).
    ..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
    ..... display Σ 1..1 string Name of the assigning organisation
    ... status ?!SOΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    Binding: RequestStatus (required): The status of the communication request.
    Fixed Value: active
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... statusReason 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: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... 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 SO 1..1 Reference(AU Core Patient) Patient that is the subject of the communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... about SO 1..* Reference(AU eRequesting Pathology Request | AU eRequesting Imaging Request | AU eRequesting Task Group) Resources that pertain to this communication request
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... 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 SOΣ 1..1 dateTime When request transitioned to being actionable
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... requester SOΣ 1..1 Reference(AU Core PractitionerRole | AU Core Patient | AU Core Organization) Provider, Patient, or Organisation requesting the communication
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... recipient SO 1..1 Reference(AU Core PractitionerRole | AU Core Patient) Message recipient
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... sender SOΣ 0..1 Reference(AU Core Organization) Organisation sending the communication
    ObligationsActor
    SHALL:populate-if-known AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... reasonCode SOΣ 1..1 CodeableConcept Why is communication needed?
    Binding: AU eRequesting CommunicationRequest Reason (required)
    ObligationsActor
    SHALL:populate AU eRequesting Placer
    SHALL:handle AU eRequesting Filler
    SHALL:handle AU eRequesting Server
    SHALL:able-to-populate AU eRequesting Server
    SHALL:no-error AU eRequesting Patient
    ... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
    ... note 0..* Annotation Comments made about communication request

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    CommunicationRequest.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
    CommunicationRequest.​groupIdentifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    CommunicationRequest.​groupIdentifier.type Base required Order Identifier Type 📦6.0.0-ci-build AU Base Implementation Guide vnull
    CommunicationRequest.​groupIdentifier.assigner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
    CommunicationRequest.​status Base required RequestStatus 📍4.0.1 FHIR Std.
    CommunicationRequest.​statusReason Base example Not Stated Unknown
    CommunicationRequest.​category Base example CommunicationCategory 📍4.0.1 FHIR Std.
    CommunicationRequest.​priority Base required Request priority 📍4.0.1 FHIR Std.
    CommunicationRequest.​medium Base example ParticipationMode 📦3.0.0 THO v6.5
    CommunicationRequest.​reasonCode Base required AU eRequesting CommunicationRequest Reason 📦1.0.0-ci-build This IG

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error CommunicationRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error CommunicationRequest 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 CommunicationRequest 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 CommunicationRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice CommunicationRequest A resource should have narrative for robust management text.`div`.exists()
    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()

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU eRequesting CapabilityStatements for a complete list of supported RESTful interactions for this IG.

    FHIR search operations are described here and the syntax used to describe AU eRequesting interactions is defined here.

    Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”.

    Parameter(s) Server Conformance Placer Conformance Filler Conformance Patient Conformance Type(s) Requirements (when used alone or in combination)
    _id SHALL MAY MAY MAY token

    Search Parameters:

    The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.

    1. _id search parameter

      GET [base]/CommunicationRequest?_id=[id]

      Example:

      1. GET [base]/CommunicationRequest?_id=2169591

      Implementation Notes: Fetches a bundle with the requested CommunicationRequest, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)