Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
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-modi-1 | Version: 0.0.8 | |||
| Draft as of 2024-09-12 | Computable Name: MODIServiceRequest | |||
Copyright/Legal: Copyright © 2023 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 representation of a request for a diagnostic imaging service for use in the Modernisation of Diagnostic Imaging (MODI) Proof of Concept.
This profile identifies the additional constraints, extensions, and value sets that build on and extend ServiceRequest and AU Diagnostic Service Request that are supported.
This profile is designed to:
This profile may be referred to by APIs, which will be listed here when available.
NOTE: Must support to be defined handled by MODI documentation.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseDiagnosticRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | Request for diagnostic imaging service inv-dh-srr-01: If present, a performer shall at least have a reference or display or a valid identifier |
  Slices for extension |
Content/Rules for all slices | |||
   targetBodyStructure |
S | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure |
 hl7V2MessageBase64 |
S | 0..1 | base64Binary | HL7 V2 message conveyed directly as data inline, base64 encoded URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-hl7-v2-base64-1 |
  identifier |
S | 1..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order |
| status |
S | 1..1 | code | draft | active | revoked | completed |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order | |
| Slices for category |
S | 1..* | CodeableConcept | Classification of the service requested as diagnostic imaging + modality where available Slice: Unordered, Open by pattern:$this |
 category:diagImg |
1..1 | CodeableConcept | Diagnostic imaging service Required Pattern: At least the following | |
   coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 708175003 | |
| code |
S | 1..1 | CodeableConcept | What is being requested/ordered Required Pattern: At least the following |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
 subject |
S | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| authoredOn |
S | 1..1 | dateTime | Date request signed |
| requester |
S | 1..1 | Reference(ADHA Authoring PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| performer |
SC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core HealthcareService) | Requested performer |
| reasonCode |
S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request  (preferred) |
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite |
S | 0..* | CodeableConcept | Location on Body Binding: Body Site (required) |
| note |
S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| ServiceRequest.bodySite | required | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-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()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | Request for diagnostic imaging service 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 |
| Slices for extension |
Content/Rules for all slices | |||
| targetBodyStructure |
S | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure |
| hl7V2MessageBase64 |
S | 0..1 | base64Binary | HL7 V2 message conveyed directly as data inline, base64 encoded URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-hl7-v2-base64-1 |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
S | 1..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order |
| status |
?!SΣ | 1..1 | code | draft | active | revoked | completed Binding: RequestStatus (required): The status of a service order. |
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order |
| Slices for category |
SΣ | 1..* | CodeableConcept | Classification of the service requested as diagnostic imaging + modality where available Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:diagImg |
Σ | 1..1 | CodeableConcept | Diagnostic imaging service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 708175003 | |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure (example)Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| subject |
SΣ | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| authoredOn |
SΣ | 1..1 | dateTime | Date request signed |
| requester |
SΣ | 1..1 | Reference(ADHA Authoring PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| performer |
SΣC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core HealthcareService) | Requested performer |
| reasonCode |
SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) |
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite |
SΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (required) |
| note |
S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:diagImg | example | Pattern: SNOMED-CT Code 708175003http://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.code | example | Pattern: SNOMED-CT Code nullhttps://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | |
| ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| ServiceRequest.bodySite | required | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-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()) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | Request for diagnostic imaging service 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 | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| targetBodyStructure |
S | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | ||||
| hl7V2MessageBase64 |
S | 0..1 | base64Binary | HL7 V2 message conveyed directly as data inline, base64 encoded URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-hl7-v2-base64-1 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 1..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | draft | active | revoked | completed Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
| Slices for category |
SΣ | 1..* | CodeableConcept | Classification of the service requested as diagnostic imaging + modality where available Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:diagImg |
Σ | 1..1 | CodeableConcept | Diagnostic imaging service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Required Pattern: At least the following | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
 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://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 708175003 | |||||
| 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 | |||||
| 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: Evaluation Procedure (example)Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| 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://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
| 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(ADHA Core Patient) | Individual or Entity the service is ordered for | ||||
| 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 | 1..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 |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
Σ | 0..1 | Reference(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Σ | 1..1 | dateTime | Date request signed | ||||
| requester |
SΣ | 1..1 | Reference(ADHA Authoring PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) | ||||
| 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 | 1..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 |
Σ | 0..1 | string | Text alternative for the resource | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | ||||
| performer |
SΣC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core HealthcareService) | 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 |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | 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(AU Base Specimen) | Procedure Samples | ||||
| bodySite |
SΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (required) | ||||
| note |
S | 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 / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:diagImg | example | Pattern: SNOMED-CT Code 708175003http://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | Pattern: SNOMED-CT Code nullhttps://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.requester.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom 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 | required | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-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()) |
This structure is derived from AUBaseDiagnosticRequest
Summary
Mandatory: 9 elements
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AUBaseDiagnosticRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | Request for diagnostic imaging service inv-dh-srr-01: If present, a performer shall at least have a reference or display or a valid identifier |
| Slices for extension |
Content/Rules for all slices | |||
| targetBodyStructure |
S | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure |
| hl7V2MessageBase64 |
S | 0..1 | base64Binary | HL7 V2 message conveyed directly as data inline, base64 encoded URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-hl7-v2-base64-1 |
| identifier |
S | 1..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order |
| status |
S | 1..1 | code | draft | active | revoked | completed |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order | |
| Slices for category |
S | 1..* | CodeableConcept | Classification of the service requested as diagnostic imaging + modality where available Slice: Unordered, Open by pattern:$this |
| category:diagImg |
1..1 | CodeableConcept | Diagnostic imaging service Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 708175003 | |
| code |
S | 1..1 | CodeableConcept | What is being requested/ordered Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| subject |
S | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| authoredOn |
S | 1..1 | dateTime | Date request signed |
| requester |
S | 1..1 | Reference(ADHA Authoring PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) |
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
| performer |
SC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core HealthcareService) | Requested performer |
| reasonCode |
S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) |
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite |
S | 0..* | CodeableConcept | Location on Body Binding: Body Site (required) |
| note |
S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| ServiceRequest.bodySite | required | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-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()) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | Request for diagnostic imaging service 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 |
| Slices for extension |
Content/Rules for all slices | |||
| targetBodyStructure |
S | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure |
| hl7V2MessageBase64 |
S | 0..1 | base64Binary | HL7 V2 message conveyed directly as data inline, base64 encoded URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-hl7-v2-base64-1 |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
S | 1..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order |
| status |
?!SΣ | 1..1 | code | draft | active | revoked | completed Binding: RequestStatus (required): The status of a service order. |
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order |
| Slices for category |
SΣ | 1..* | CodeableConcept | Classification of the service requested as diagnostic imaging + modality where available Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:diagImg |
Σ | 1..1 | CodeableConcept | Diagnostic imaging service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 708175003 | |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure (example)Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| subject |
SΣ | 1..1 | Reference(ADHA Core Patient) | Individual or Entity the service is ordered for |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| authoredOn |
SΣ | 1..1 | dateTime | Date request signed |
| requester |
SΣ | 1..1 | Reference(ADHA Authoring PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| performer |
SΣC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core HealthcareService) | Requested performer |
| reasonCode |
SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) |
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite |
SΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (required) |
| note |
S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:diagImg | example | Pattern: SNOMED-CT Code 708175003http://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.code | example | Pattern: SNOMED-CT Code nullhttps://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | |
| ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| ServiceRequest.bodySite | required | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-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()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | Request for diagnostic imaging service 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| targetBodyStructure |
S | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | ||||
| hl7V2MessageBase64 |
S | 0..1 | base64Binary | HL7 V2 message conveyed directly as data inline, base64 encoded URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-hl7-v2-base64-1 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 1..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | draft | active | revoked | completed Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
| Slices for category |
SΣ | 1..* | CodeableConcept | Classification of the service requested as diagnostic imaging + modality where available Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:diagImg |
Σ | 1..1 | CodeableConcept | Diagnostic imaging service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| 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://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 708175003 | |||||
| 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 | |||||
| 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: Evaluation Procedure (example)Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| 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://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
| 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(ADHA Core Patient) | Individual or Entity the service is ordered for | ||||
| 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 | 1..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 |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
Σ | 0..1 | Reference(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Σ | 1..1 | dateTime | Date request signed | ||||
| requester |
SΣ | 1..1 | Reference(ADHA Authoring PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) | ||||
| 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 | 1..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 |
Σ | 0..1 | string | Text alternative for the resource | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | ||||
| performer |
SΣC | 0..* | Reference(ADHA Core PractitionerRole | ADHA Core HealthcareService) | 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 |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | 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(AU Base Specimen) | Procedure Samples | ||||
| bodySite |
SΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (required) | ||||
| note |
S | 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 / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:diagImg | example | Pattern: SNOMED-CT Code 708175003http://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | Pattern: SNOMED-CT Code nullhttps://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.requester.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom 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 | required | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-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()) |
This structure is derived from AUBaseDiagnosticRequest
Summary
Mandatory: 9 elements
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
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.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-09-12
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
