Diagnostic Requests
0.0.9 - CI Build Australia flag

Diagnostic Requests, published by Special Committee or Project or Initiative or Collective. This guide is not an authorized publication; it is the continuous build for version 0.0.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/draft-diagnostic-orders/ and changes regularly. See the Directory of published versions

Resource Profile: Diagnostic Service Request Radiology

Official URL: http://draft.hl7.org.au/fhir/diagnostic-orders/StructureDefinition/erequest-diagnosticrequest-radiology Version: 0.0.9
Draft as of 2024-04-09 Computable Name: ERequestDiagnosticRequestRadiology

Diagnostic Service Request for Radiology. This will in future hold radiology-specific requesting content.

Usage:

Formal Views of Profile Content

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

This structure is derived from ERequestDiagnosticRequestBase

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest ERequestDiagnosticRequestBase
... code S 1..1 CodeableConcept Radiology procedure code or free text name
.... coding 0..* Coding Ideally a value set from SNOMED-CT, but may need to support provider maintained codes.
.... text 1..1 string Procedure name selected or free text entered by the user

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ERequestDiagnosticRequestBase Diagnostic Service Request Base
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:coverage S 0..1 ERequestCoverage Insurance or medical plan or a payment agreement
.... contained:encounter S 0..1 ERequestEncounter An encounter in an Australian healthcare context
.... contained:supportingObs S 0..* Observation Contained, inline Resources
.... targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
.... copiesto S 0..* Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | Location | HealthcareService | CareTeam | Endpoint) Result copies to
URL: http://hl7.org.au/fhir/StructureDefinition/result-copies-to
.... requestFasting S 0..1 CodeableConcept The condition or state of the patient for this test
URL: http://hl7.org/fhir/StructureDefinition/servicerequest-precondition profiled by http://draft.hl7.org.au/fhir/diagnostic-orders/StructureDefinition/erequest-servicerequest-fasting
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | completed | revoked
Binding: eRequest Service Request Status codes (required)
... 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: option
... category SΣ 1..1 CodeableConcept Classification of service
Binding: eRequest Service Request Category codes (required)
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: eRequest Priority codes (required)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept Radiology procedure code or free text name
Binding: Evaluation Procedure . (example)
.... coding Σ 0..* Coding Ideally a value set from SNOMED-CT, but may need to support provider maintained codes.
.... text Σ 1..1 string Procedure name selected or free text entered by the user
... subject SΣ 1..1 Reference(AU Core Patient) Individual or Entity the service is ordered for
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... encounter SΣ 1..1 Reference(Diagnostic Encounter) Encounter in which the request was created
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... authoredOn Σ 1..1 dateTime Date requested
... requester Σ 1..1 Reference(Diagnostic PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... reasonCode SΣ 0..1 CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
.... text Σ 1..1 string Plain text representation of the concept
... insurance S 1..1 Reference(Diagnostic Coverage) Reference to Coverage resource for funding type
.... reference ΣC 1..1 string Reference to contained Coverage resource
... Slices for supportingInfo SC 0..* Reference(Observation | Condition) Supporting request information such as pregnacy status
Slice: Unordered, Open by profile:$this.resolve()
narrative-for-supportinginfo: Always require a narrative for supportingInfo references in ServiceRequest
.... supportingInfo:All Slices Content/Rules for all slices
..... reference ΣC 1..1 string Reference to contained resource or relative resource URL
.... supportingInfo:pregnancystatus S 0..1 Reference(AU Core Pregnancy Status) Additional clinical information
.... supportingInfo:gestationalage S 0..1 Reference(AU Core Gestational Age) Additional clinical information
.... supportingInfo:lastmenstrualperiod S 0..1 Reference(AU Core Last Menstrual Period) Additional clinical information
... patientInstruction SΣ 0..1 string Instructions to patient. Must support where available.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.statusrequiredERequestServiceRequestStatus
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-servicerequeststatus
from this IG
ServiceRequest.intentrequiredFixed Value: option
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryrequiredERequestServiceRequestCategory
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-servicerequestcategory
from this IG
ServiceRequest.priorityrequiredERequestPriority
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-priority
from this IG
ServiceRequest.codeexampleEvaluationProcedure .
https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
ServiceRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
narrative-for-supportinginfoerrorServiceRequest.supportingInfoAlways require a narrative for supportingInfo references in ServiceRequest
: resolve().text.div.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ERequestDiagnosticRequestBase Diagnostic Service Request Base
prr-1: orderDetail SHALL only be present if code is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:coverage S 0..1 ERequestCoverage Insurance or medical plan or a payment agreement
.... contained:encounter S 0..1 ERequestEncounter An encounter in an Australian healthcare context
.... contained:supportingObs S 0..* Observation Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
... copiesto S 0..* Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | Location | HealthcareService | CareTeam | Endpoint) Result copies to
URL: http://hl7.org.au/fhir/StructureDefinition/result-copies-to
... requestFasting S 0..1 CodeableConcept The condition or state of the patient for this test
URL: http://hl7.org/fhir/StructureDefinition/servicerequest-precondition profiled by http://draft.hl7.org.au/fhir/diagnostic-orders/StructureDefinition/erequest-servicerequest-fasting
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* 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 1..1 ERequestPlacerGroupNumber Diagnostic Placer Group Number
... status ?!Σ 1..1 code active | completed | revoked
Binding: eRequest Service Request Status codes (required)
... 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: option
... category SΣ 1..1 CodeableConcept Classification of service
Binding: eRequest Service Request Category codes (required)
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: eRequest Priority codes (required)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept Radiology procedure code or free text name
Binding: Evaluation Procedure . (example)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Ideally a value set from SNOMED-CT, but may need to support provider maintained codes.
.... text Σ 1..1 string Procedure name selected or free text entered by the user
... 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
.... 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 SΣ 0..1 string Text alternative for the resource
... encounter SΣ 1..1 Reference(Diagnostic Encounter) Encounter in which the request was created
.... 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
... 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 Σ 1..1 dateTime Date requested
... requester Σ 1..1 Reference(Diagnostic PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ProcedurePerformerRoleCodes (required)
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | 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..1 CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 1..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance S 1..1 Reference(Diagnostic Coverage) Reference to Coverage resource for funding type
.... 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 Reference to contained Coverage resource
.... 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
... Slices for supportingInfo SC 0..* Reference(Observation | Condition) Supporting request information such as pregnacy status
Slice: Unordered, Open by profile:$this.resolve()
narrative-for-supportinginfo: Always require a narrative for supportingInfo references in ServiceRequest
.... supportingInfo:All Slices Content/Rules for all slices
..... 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 Reference to contained resource or relative resource 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
.... supportingInfo:pregnancystatus S 0..1 Reference(AU Core Pregnancy Status) Additional clinical information
.... supportingInfo:gestationalage S 0..1 Reference(AU Core Gestational Age) Additional clinical information
.... supportingInfo:lastmenstrualperiod S 0..1 Reference(AU Core Last Menstrual Period) Additional clinical information
... specimen Σ 0..* Reference(AU Base Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: Body Site . (preferred)
... note 0..* Annotation Comments
... patientInstruction SΣ 0..1 string Instructions to patient. Must support where available.
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredERequestServiceRequestStatus
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-servicerequeststatus
from this IG
ServiceRequest.intentrequiredFixed Value: option
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryrequiredERequestServiceRequestCategory
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-servicerequestcategory
from this IG
ServiceRequest.priorityrequiredERequestPriority
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-priority
from this IG
ServiceRequest.codeexampleEvaluationProcedure .
https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTyperequiredProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
ServiceRequest.insurance.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.supportingInfo.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.bodySitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
narrative-for-supportinginfoerrorServiceRequest.supportingInfoAlways require a narrative for supportingInfo references in ServiceRequest
: resolve().text.div.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from ERequestDiagnosticRequestBase

Summary

Mandatory: 2 elements
Must-Support: 1 element

Differential View

This structure is derived from ERequestDiagnosticRequestBase

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest ERequestDiagnosticRequestBase
... code S 1..1 CodeableConcept Radiology procedure code or free text name
.... coding 0..* Coding Ideally a value set from SNOMED-CT, but may need to support provider maintained codes.
.... text 1..1 string Procedure name selected or free text entered by the user

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ERequestDiagnosticRequestBase Diagnostic Service Request Base
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:coverage S 0..1 ERequestCoverage Insurance or medical plan or a payment agreement
.... contained:encounter S 0..1 ERequestEncounter An encounter in an Australian healthcare context
.... contained:supportingObs S 0..* Observation Contained, inline Resources
.... targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
.... copiesto S 0..* Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | Location | HealthcareService | CareTeam | Endpoint) Result copies to
URL: http://hl7.org.au/fhir/StructureDefinition/result-copies-to
.... requestFasting S 0..1 CodeableConcept The condition or state of the patient for this test
URL: http://hl7.org/fhir/StructureDefinition/servicerequest-precondition profiled by http://draft.hl7.org.au/fhir/diagnostic-orders/StructureDefinition/erequest-servicerequest-fasting
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | completed | revoked
Binding: eRequest Service Request Status codes (required)
... 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: option
... category SΣ 1..1 CodeableConcept Classification of service
Binding: eRequest Service Request Category codes (required)
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: eRequest Priority codes (required)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept Radiology procedure code or free text name
Binding: Evaluation Procedure . (example)
.... coding Σ 0..* Coding Ideally a value set from SNOMED-CT, but may need to support provider maintained codes.
.... text Σ 1..1 string Procedure name selected or free text entered by the user
... subject SΣ 1..1 Reference(AU Core Patient) Individual or Entity the service is ordered for
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... encounter SΣ 1..1 Reference(Diagnostic Encounter) Encounter in which the request was created
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... authoredOn Σ 1..1 dateTime Date requested
... requester Σ 1..1 Reference(Diagnostic PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... reasonCode SΣ 0..1 CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
.... text Σ 1..1 string Plain text representation of the concept
... insurance S 1..1 Reference(Diagnostic Coverage) Reference to Coverage resource for funding type
.... reference ΣC 1..1 string Reference to contained Coverage resource
... Slices for supportingInfo SC 0..* Reference(Observation | Condition) Supporting request information such as pregnacy status
Slice: Unordered, Open by profile:$this.resolve()
narrative-for-supportinginfo: Always require a narrative for supportingInfo references in ServiceRequest
.... supportingInfo:All Slices Content/Rules for all slices
..... reference ΣC 1..1 string Reference to contained resource or relative resource URL
.... supportingInfo:pregnancystatus S 0..1 Reference(AU Core Pregnancy Status) Additional clinical information
.... supportingInfo:gestationalage S 0..1 Reference(AU Core Gestational Age) Additional clinical information
.... supportingInfo:lastmenstrualperiod S 0..1 Reference(AU Core Last Menstrual Period) Additional clinical information
... patientInstruction SΣ 0..1 string Instructions to patient. Must support where available.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.statusrequiredERequestServiceRequestStatus
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-servicerequeststatus
from this IG
ServiceRequest.intentrequiredFixed Value: option
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryrequiredERequestServiceRequestCategory
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-servicerequestcategory
from this IG
ServiceRequest.priorityrequiredERequestPriority
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-priority
from this IG
ServiceRequest.codeexampleEvaluationProcedure .
https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
ServiceRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
narrative-for-supportinginfoerrorServiceRequest.supportingInfoAlways require a narrative for supportingInfo references in ServiceRequest
: resolve().text.div.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ERequestDiagnosticRequestBase Diagnostic Service Request Base
prr-1: orderDetail SHALL only be present if code is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... Slices for contained 0..* Resource Contained, inline Resources
Slice: Unordered, Open by type:$this
.... contained:coverage S 0..1 ERequestCoverage Insurance or medical plan or a payment agreement
.... contained:encounter S 0..1 ERequestEncounter An encounter in an Australian healthcare context
.... contained:supportingObs S 0..* Observation Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
... copiesto S 0..* Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization | Location | HealthcareService | CareTeam | Endpoint) Result copies to
URL: http://hl7.org.au/fhir/StructureDefinition/result-copies-to
... requestFasting S 0..1 CodeableConcept The condition or state of the patient for this test
URL: http://hl7.org/fhir/StructureDefinition/servicerequest-precondition profiled by http://draft.hl7.org.au/fhir/diagnostic-orders/StructureDefinition/erequest-servicerequest-fasting
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* 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 1..1 ERequestPlacerGroupNumber Diagnostic Placer Group Number
... status ?!Σ 1..1 code active | completed | revoked
Binding: eRequest Service Request Status codes (required)
... 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: option
... category SΣ 1..1 CodeableConcept Classification of service
Binding: eRequest Service Request Category codes (required)
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: eRequest Priority codes (required)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept Radiology procedure code or free text name
Binding: Evaluation Procedure . (example)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Ideally a value set from SNOMED-CT, but may need to support provider maintained codes.
.... text Σ 1..1 string Procedure name selected or free text entered by the user
... 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
.... 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 SΣ 0..1 string Text alternative for the resource
... encounter SΣ 1..1 Reference(Diagnostic Encounter) Encounter in which the request was created
.... 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
... 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 Σ 1..1 dateTime Date requested
... requester Σ 1..1 Reference(Diagnostic PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ProcedurePerformerRoleCodes (required)
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | 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..1 CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 1..1 string Plain text representation of the concept
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance S 1..1 Reference(Diagnostic Coverage) Reference to Coverage resource for funding type
.... 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 Reference to contained Coverage resource
.... 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
... Slices for supportingInfo SC 0..* Reference(Observation | Condition) Supporting request information such as pregnacy status
Slice: Unordered, Open by profile:$this.resolve()
narrative-for-supportinginfo: Always require a narrative for supportingInfo references in ServiceRequest
.... supportingInfo:All Slices Content/Rules for all slices
..... 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 Reference to contained resource or relative resource 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
.... supportingInfo:pregnancystatus S 0..1 Reference(AU Core Pregnancy Status) Additional clinical information
.... supportingInfo:gestationalage S 0..1 Reference(AU Core Gestational Age) Additional clinical information
.... supportingInfo:lastmenstrualperiod S 0..1 Reference(AU Core Last Menstrual Period) Additional clinical information
... specimen Σ 0..* Reference(AU Base Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: Body Site . (preferred)
... note 0..* Annotation Comments
... patientInstruction SΣ 0..1 string Instructions to patient. Must support where available.
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredERequestServiceRequestStatus
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-servicerequeststatus
from this IG
ServiceRequest.intentrequiredFixed Value: option
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryrequiredERequestServiceRequestCategory
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-servicerequestcategory
from this IG
ServiceRequest.priorityrequiredERequestPriority
http://draft.hl7.org.au/fhir/diagnostic-orders/ValueSet/erequest-priority
from this IG
ServiceRequest.codeexampleEvaluationProcedure .
https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTyperequiredProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
ServiceRequest.insurance.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.supportingInfo.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.bodySitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
narrative-for-supportinginfoerrorServiceRequest.supportingInfoAlways require a narrative for supportingInfo references in ServiceRequest
: resolve().text.div.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from ERequestDiagnosticRequestBase

Summary

Mandatory: 2 elements
Must-Support: 1 element

 

Other representations of profile: CSV, Excel, Schematron