Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-servicerequest-core-1 | Version: 0.0.6 | |||
Draft as of 2024-09-12 | Computable Name: ADHAServiceRequestCore | |||
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
The purpose of this profile is to provide a core representation of a record of request for a service for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
This profile identifies the additional constraints, extensions, and value sets that build on and extend ServiceRequest that are supported.
Where a more specific ServiceRequest profile is applicable an implementation SHALL ensure the resource conforms to that specific profile.
This profile is designed to set a core ServiceRequest standard for:
This profile may be referred to by APIs, which will be listed here when available.
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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed inv-dh-srr-01: If present, a performer shall at least have a reference or display or a valid identifier |
identifier | S | 0..* | Identifier | Identifiers assigned to this order |
basedOn | S | 0..* | Reference(ADHA Core MedicationRequest | ADHA Core ServiceRequest) | What request fulfills |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
category | S | 0..* | CodeableConcept | Classification of service Binding: Service Type (example) |
code | S | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure (preferred) |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for inv-dh-srr-02: At least reference or a valid identifier shall be present |
encounter | S | 0..1 | Reference(ADHA Core Encounter) | Encounter in which the request was created |
authoredOn | S | 0..1 | dateTime | Date request signed |
requester | SC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA System Device) | Who/what is requesting service inv-dh-srr-03: At least reference or display or a valid identifier shall be present |
performerType | S | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) |
performer | SC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core Organization | CareTeam | ADHA Core HealthcareService | ADHA Core Patient | ADHA Core RelatedPerson) | Requested performer |
reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) |
reasonReference | S | 0..* | Reference(ADHA Core Condition | ADHA Core Observation | ADHA Core DiagnosticReport | ADHA Core DocumentReference) | Explanation/Justification for service or service |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.category | example | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
ServiceRequest.code | preferred | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | |
ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-srr-01 | error | ServiceRequest | If present, a performer shall at least have a reference or display or a valid identifier : performer.exists() implies performer.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
inv-dh-srr-02 | error | ServiceRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-srr-03 | error | ServiceRequest.requester | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present inv-dh-srr-01: If present, a performer shall at least have a reference or display or a valid identifier |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order |
basedOn | SΣ | 0..* | Reference(ADHA Core MedicationRequest | ADHA Core ServiceRequest) | What request fulfills |
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: Service Type (example) |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure (preferred) |
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for inv-dh-srr-02: At least reference or a valid identifier shall be present |
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Encounter in which the request was created |
authoredOn | SΣ | 0..1 | dateTime | Date request signed |
requester | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA System Device) | Who/what is requesting service inv-dh-srr-03: At least reference or display or a valid identifier shall be present |
performerType | SΣ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) |
performer | SΣC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core Organization | CareTeam | ADHA Core HealthcareService | ADHA Core Patient | ADHA Core RelatedPerson) | Requested performer |
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) |
reasonReference | SΣ | 0..* | Reference(ADHA Core Condition | ADHA Core Observation | ADHA Core DiagnosticReport | ADHA Core DocumentReference) | Explanation/Justification for service or service |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | |
ServiceRequest.category | example | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
ServiceRequest.code | preferred | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | |
ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-srr-01 | error | ServiceRequest | If present, a performer shall at least have a reference or display or a valid identifier : performer.exists() implies performer.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
inv-dh-srr-02 | error | ServiceRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-srr-03 | error | ServiceRequest.requester | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present inv-dh-srr-01: If present, a performer shall at least have a reference or display or a valid identifier | ||||
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(ADHA Core MedicationRequest | ADHA 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: Service Type (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: Procedure (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ΣC | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for inv-dh-srr-02: At least reference or a valid identifier shall be present | ||||
encounter | SΣ | 0..1 | Reference(ADHA 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 "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA System Device) | Who/what is requesting service inv-dh-srr-03: At least reference or display or a valid identifier shall be present | ||||
performerType | SΣ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | ||||
performer | SΣC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core Organization | CareTeam | ADHA Core HealthcareService | ADHA Core Patient | ADHA 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: Reason for Request (preferred) | ||||
reasonReference | SΣ | 0..* | Reference(ADHA Core Condition | ADHA Core Observation | ADHA Core DiagnosticReport | ADHA 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 | URI | |||
ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | example | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | preferred | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-srr-01 | error | ServiceRequest | If present, a performer shall at least have a reference or display or a valid identifier : performer.exists() implies performer.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
inv-dh-srr-02 | error | ServiceRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-srr-03 | error | ServiceRequest.requester | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
This structure is derived from ServiceRequest
Summary
Mandatory: 3 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed inv-dh-srr-01: If present, a performer shall at least have a reference or display or a valid identifier |
identifier | S | 0..* | Identifier | Identifiers assigned to this order |
basedOn | S | 0..* | Reference(ADHA Core MedicationRequest | ADHA Core ServiceRequest) | What request fulfills |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
category | S | 0..* | CodeableConcept | Classification of service Binding: Service Type (example) |
code | S | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure (preferred) |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for inv-dh-srr-02: At least reference or a valid identifier shall be present |
encounter | S | 0..1 | Reference(ADHA Core Encounter) | Encounter in which the request was created |
authoredOn | S | 0..1 | dateTime | Date request signed |
requester | SC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA System Device) | Who/what is requesting service inv-dh-srr-03: At least reference or display or a valid identifier shall be present |
performerType | S | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) |
performer | SC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core Organization | CareTeam | ADHA Core HealthcareService | ADHA Core Patient | ADHA Core RelatedPerson) | Requested performer |
reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) |
reasonReference | S | 0..* | Reference(ADHA Core Condition | ADHA Core Observation | ADHA Core DiagnosticReport | ADHA Core DocumentReference) | Explanation/Justification for service or service |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.category | example | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
ServiceRequest.code | preferred | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | |
ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-srr-01 | error | ServiceRequest | If present, a performer shall at least have a reference or display or a valid identifier : performer.exists() implies performer.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
inv-dh-srr-02 | error | ServiceRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-srr-03 | error | ServiceRequest.requester | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present inv-dh-srr-01: If present, a performer shall at least have a reference or display or a valid identifier |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order |
basedOn | SΣ | 0..* | Reference(ADHA Core MedicationRequest | ADHA Core ServiceRequest) | What request fulfills |
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: Service Type (example) |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure (preferred) |
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for inv-dh-srr-02: At least reference or a valid identifier shall be present |
encounter | SΣ | 0..1 | Reference(ADHA Core Encounter) | Encounter in which the request was created |
authoredOn | SΣ | 0..1 | dateTime | Date request signed |
requester | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA System Device) | Who/what is requesting service inv-dh-srr-03: At least reference or display or a valid identifier shall be present |
performerType | SΣ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) |
performer | SΣC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core Organization | CareTeam | ADHA Core HealthcareService | ADHA Core Patient | ADHA Core RelatedPerson) | Requested performer |
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) |
reasonReference | SΣ | 0..* | Reference(ADHA Core Condition | ADHA Core Observation | ADHA Core DiagnosticReport | ADHA Core DocumentReference) | Explanation/Justification for service or service |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | |
ServiceRequest.category | example | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
ServiceRequest.code | preferred | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | |
ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-srr-01 | error | ServiceRequest | If present, a performer shall at least have a reference or display or a valid identifier : performer.exists() implies performer.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
inv-dh-srr-02 | error | ServiceRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-srr-03 | error | ServiceRequest.requester | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present inv-dh-srr-01: If present, a performer shall at least have a reference or display or a valid identifier | ||||
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(ADHA Core MedicationRequest | ADHA 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: Service Type (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: Procedure (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ΣC | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for inv-dh-srr-02: At least reference or a valid identifier shall be present | ||||
encounter | SΣ | 0..1 | Reference(ADHA 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 "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Organization | ADHA Core Patient | ADHA Authoring RelatedPerson | ADHA System Device) | Who/what is requesting service inv-dh-srr-03: At least reference or display or a valid identifier shall be present | ||||
performerType | SΣ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | ||||
performer | SΣC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core Organization | CareTeam | ADHA Core HealthcareService | ADHA Core Patient | ADHA 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: Reason for Request (preferred) | ||||
reasonReference | SΣ | 0..* | Reference(ADHA Core Condition | ADHA Core Observation | ADHA Core DiagnosticReport | ADHA 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 | URI | |||
ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | example | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | preferred | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-srr-01 | error | ServiceRequest | If present, a performer shall at least have a reference or display or a valid identifier : performer.exists() implies performer.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
inv-dh-srr-02 | error | ServiceRequest.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-srr-03 | error | ServiceRequest.requester | At least reference or display or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |
This structure is derived from ServiceRequest
Summary
Mandatory: 3 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
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.