AU Core Implementation Guide
0.1.0-draft - Draft
This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-servicerequest | Version: 0.1.0-draft | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreServiceRequest | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
This profile sets minimum expectations for a ServiceRequest resource to record, search, and fetch information about requests, plans, or orders for a service for a patient. It is based on the core ServiceRequest resource and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
ServiceRequest.category
provides an efficient way of supporting system interactions, e.g. restricting searches. Implementers need to understand that data categorisation is somewhat subjective. The categorisation applied by the source may not align with a receiver’s expectations.ServiceRequest.reasonCode
, or a reference with ServiceRequest.reasonReference
to a Condition or other resource.
ServiceRequest.performerType
, or a reference with ServiceRequest.performer
to a HealthcareService or other resource.
ServiceRequest.supportingInfo
is broad to accommodate a wide variety of use cases by allowing a reference to any resource.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
Path | Conformance | ValueSet |
ServiceRequest.category | example | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 |
ServiceRequest.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 |
ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 |
ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
Path | Conformance | ValueSet |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | RequestIntent |
ServiceRequest.category | example | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 |
ServiceRequest.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 |
ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 |
ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed | ||||
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 | SΣ | 0..* | Identifier | Identifiers assigned to this order | ||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | SΣ | 0..* | Reference(AU Core MedicationRequest | AU Core ServiceRequest) | What request fulfills | ||||
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
category | SΣ | 0..* | CodeableConcept | Classification of service Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (example) | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred) | ||||
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | SΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for | ||||
encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Encounter in which the request was created | ||||
occurrence[x] | Σ | 0..1 | When service should occur | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example \u0022pain\u0022, \u0022on flare-up\u0022, etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣ | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson | AU Core System Device) | Who/what is requesting service | ||||
performerType | SΣ | 0..1 | CodeableConcept | Performer role Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) | ||||
performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Care Team | AU Core HealthcareService | AU Core Patient | AU Core RelatedPerson) | Requested performer | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) | ||||
reasonReference | SΣ | 0..* | Reference(AU Core Condition | AU Core Observation | AU Core DiagnosticReport | AU Core DocumentReference) | Explanation/Justification for service or service | ||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information | ||||
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
ServiceRequest.language | preferred | CommonLanguages
| ||||
ServiceRequest.status | required | RequestStatus | ||||
ServiceRequest.intent | required | RequestIntent | ||||
ServiceRequest.category | example | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
ServiceRequest.priority | required | RequestPriority | ||||
ServiceRequest.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
This structure is derived from ServiceRequest
Summary
Mandatory: 3 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from ServiceRequest
Path | Conformance | ValueSet |
ServiceRequest.category | example | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 |
ServiceRequest.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 |
ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 |
ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
Key Elements View
Path | Conformance | ValueSet |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | RequestIntent |
ServiceRequest.category | example | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 |
ServiceRequest.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 |
ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 |
ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed | ||||
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 | SΣ | 0..* | Identifier | Identifiers assigned to this order | ||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | SΣ | 0..* | Reference(AU Core MedicationRequest | AU Core ServiceRequest) | What request fulfills | ||||
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
category | SΣ | 0..* | CodeableConcept | Classification of service Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (example) | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred) | ||||
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | SΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for | ||||
encounter | SΣ | 0..1 | Reference(AU Core Encounter) | Encounter in which the request was created | ||||
occurrence[x] | Σ | 0..1 | When service should occur | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example \u0022pain\u0022, \u0022on flare-up\u0022, etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣ | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson | AU Core System Device) | Who/what is requesting service | ||||
performerType | SΣ | 0..1 | CodeableConcept | Performer role Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) | ||||
performer | SΣ | 0..* | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Care Team | AU Core HealthcareService | AU Core Patient | AU Core RelatedPerson) | Requested performer | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) | ||||
reasonReference | SΣ | 0..* | Reference(AU Core Condition | AU Core Observation | AU Core DiagnosticReport | AU Core DocumentReference) | Explanation/Justification for service or service | ||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information | ||||
specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
ServiceRequest.language | preferred | CommonLanguages
| ||||
ServiceRequest.status | required | RequestStatus | ||||
ServiceRequest.intent | required | RequestIntent | ||||
ServiceRequest.category | example | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
ServiceRequest.priority | required | RequestPriority | ||||
ServiceRequest.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
This structure is derived from ServiceRequest
Summary
Mandatory: 3 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Name | Type | Conformance | Description | Path |
---|---|---|---|---|
TBD | TBD | TBD | TBD | TBD |
The following search parameters and search parameter combinations SHALL be supported:
The following search parameters and search parameter combinations SHOULD be supported: