AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

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

Resource Profile: AU Base Diagnostic Request

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-diagnosticrequest Version: 7.0.0-ci-build
Standards status: Deprecated Maturity Level: 1 Computable Name: AUBaseDiagnosticRequest

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a service request structure to represent a request for a diagnostic investigation in an Australian context. This profile is intended to support ordering for pathology, radiology, and specialist diagnostic investigations.

This profile was deprecated in AU Base 5.0.0 as work is being undertaken in the AU eRequesting project to define the requirements for a diagnostic request. In AU Base this profile is replaced by AU Base ServiceRequest, which localises core concepts, including identifiers and terminology, for use in an Australian context and enables implementers and modellers to make their own rules, i.e. (profiling), about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

  • The procedure-targetBodyStructure extension may be suitable for use where
    • body site is not implicit in the code found in ServiceRequest.code and
    • body site information is to be handled as a separate resource (e.g. to identify and track separately) instead of an inline coded element in ServiceRequest.bodySite.
  • ServiceRequest.code for a pathology order is preferred to be a member of the RCPA - SPIA Requesting Pathology Terminology Reference Set.
  • ServiceRequest.code for an imaging order is preferred to be a member of the Imaging Procedure value set.
  • See each Identifier profile page for guidance related to that identifier type.

Extensions under consideration:

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • One or more text definitions, invariants or bindings have changed (ServiceRequest)
  • Formal Views of Profile Content

    Description Differentials, Snapshots, and other representations.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest C 0..* ServiceRequest Deprecated: A diagnostic service request in an Australian healthcare context
    Constraints: prr-1
    ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    ServiceRequest.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ServiceRequest.Slices for extension.extension:targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
    URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
    ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    ServiceRequest.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AULocalOrderIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Identifiers assigned to this order
    ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    Binding: RequestStatus (required): The status of a service order.
    ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    Binding: RequestIntent (required): The kind of service request.
    ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
    ServiceRequest.code This element is included in summaries. 0..1 CodeableConcept What is being requested/ordered
    Binding: Evaluation Procedure (example)
    ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
    ServiceRequest.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
    ServiceRequest.performerType This element is included in summaries. 0..1 CodeableConcept Performer role
    Binding: Practitioner Role (preferred)
    ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
    Binding: Reason for Request (preferred)
    ServiceRequest.specimen This element is included in summaries. 0..* Reference(AU Base Specimen) Procedure Samples
    ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
    Binding: Body Site (preferred)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
    ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
    ServiceRequest.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au
    ServiceRequest.performerType Base preferred Practitioner Role ⏿1.0.2 tx.hl7.org.au
    ServiceRequest.reasonCode Base preferred Reason for Request ⏿1.0.1 tx.hl7.org.au
    ServiceRequest.bodySite Base preferred Body Site ⏿1.0.2 tx.hl7.org.au

    Constraints

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

    This structure is derived from ServiceRequest

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest 0..* ServiceRequest Deprecated: A diagnostic service request in an Australian healthcare context
    ServiceRequest.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ServiceRequest.Slices for extension.extension:targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
    URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
    ServiceRequest.identifier 0..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
    ServiceRequest.code 0..1 CodeableConcept What is being requested/ordered
    Binding: Evaluation Procedure (example)
    ServiceRequest.performerType 0..1 CodeableConcept Performer role
    Binding: Practitioner Role (preferred)
    ServiceRequest.reasonCode 0..* CodeableConcept Explanation/Justification for procedure or service
    Binding: Reason for Request (preferred)
    ServiceRequest.specimen 0..* Reference(AU Base Specimen) Procedure Samples
    ServiceRequest.bodySite 0..* CodeableConcept Location on Body
    Binding: Body Site (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    ServiceRequest.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au
    ServiceRequest.performerType Base preferred Practitioner Role ⏿1.0.2 tx.hl7.org.au
    ServiceRequest.reasonCode Base preferred Reason for Request ⏿1.0.1 tx.hl7.org.au
    ServiceRequest.bodySite Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest C 0..* ServiceRequest Deprecated: A diagnostic service request in an Australian healthcare context
    Constraints: prr-1
    ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
    ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    ServiceRequest.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ServiceRequest.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ServiceRequest.contained 0..* Resource Contained, inline Resources
    ServiceRequest.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ServiceRequest.Slices for extension.extension:targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
    URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
    ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    ServiceRequest.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AULocalOrderIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Identifiers assigned to this order
    ServiceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
    ServiceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
    ServiceRequest.basedOn This element is included in summaries. 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
    ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
    ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Composite Request ID
    ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    Binding: RequestStatus (required): The status of a service order.
    ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    Binding: RequestIntent (required): The kind of service request.
    ServiceRequest.category This element is included in summaries. 0..* CodeableConcept Classification of service
    Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
    ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
    Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
    ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
    ServiceRequest.code This element is included in summaries. 0..1 CodeableConcept What is being requested/ordered
    Binding: Evaluation Procedure (example)
    ServiceRequest.orderDetail This element is included in summaries. C 0..* CodeableConcept Additional order information
    Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
    ServiceRequest.quantity[x] This element is included in summaries. 0..1 Service amount
    ServiceRequest.quantity[x].quantityQuantity Quantity
    ServiceRequest.quantity[x].quantityRatio Ratio
    ServiceRequest.quantity[x].quantityRange Range
    ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
    ServiceRequest.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter in which the request was created
    ServiceRequest.occurrence[x] This element is included in summaries. 0..1 When service should occur
    ServiceRequest.occurrence[x].occurrenceDateTime dateTime
    ServiceRequest.occurrence[x].occurrencePeriod Period
    ServiceRequest.occurrence[x].occurrenceTiming Timing
    ServiceRequest.asNeeded[x] This element is included in summaries. 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.
    ServiceRequest.asNeeded[x].asNeededBoolean boolean
    ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
    ServiceRequest.authoredOn This element is included in summaries. 0..1 dateTime Date request signed
    ServiceRequest.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
    ServiceRequest.performerType This element is included in summaries. 0..1 CodeableConcept Performer role
    Binding: Practitioner Role (preferred)
    ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
    ServiceRequest.locationCode This element is included in summaries. 0..* CodeableConcept Requested location
    Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
    ServiceRequest.locationReference This element is included in summaries. 0..* Reference(Location) Requested location
    ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
    Binding: Reason for Request (preferred)
    ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
    ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
    ServiceRequest.supportingInfo 0..* Reference(Resource) Additional clinical information
    ServiceRequest.specimen This element is included in summaries. 0..* Reference(AU Base Specimen) Procedure Samples
    ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
    Binding: Body Site (preferred)
    ServiceRequest.note 0..* Annotation Comments
    ServiceRequest.patientInstruction This element is included in summaries. 0..1 string Patient or consumer-oriented instructions
    ServiceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
    ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
    ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
    ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
    ServiceRequest.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au
    ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
    ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
    ServiceRequest.performerType Base preferred Practitioner Role ⏿1.0.2 tx.hl7.org.au
    ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.5
    ServiceRequest.reasonCode Base preferred Reason for Request ⏿1.0.1 tx.hl7.org.au
    ServiceRequest.bodySite Base preferred Body Site ⏿1.0.2 tx.hl7.org.au

    Constraints

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

    This structure is derived from ServiceRequest

    Summary

    Structures

    This structure refers to these other structures:

    Extensions

    This structure refers to these extensions:

    Maturity: 1

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest C 0..* ServiceRequest Deprecated: A diagnostic service request in an Australian healthcare context
    Constraints: prr-1
    ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    ServiceRequest.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ServiceRequest.Slices for extension.extension:targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
    URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
    ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    ServiceRequest.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AULocalOrderIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Identifiers assigned to this order
    ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    Binding: RequestStatus (required): The status of a service order.
    ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    Binding: RequestIntent (required): The kind of service request.
    ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
    ServiceRequest.code This element is included in summaries. 0..1 CodeableConcept What is being requested/ordered
    Binding: Evaluation Procedure (example)
    ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
    ServiceRequest.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
    ServiceRequest.performerType This element is included in summaries. 0..1 CodeableConcept Performer role
    Binding: Practitioner Role (preferred)
    ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
    Binding: Reason for Request (preferred)
    ServiceRequest.specimen This element is included in summaries. 0..* Reference(AU Base Specimen) Procedure Samples
    ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
    Binding: Body Site (preferred)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
    ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
    ServiceRequest.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au
    ServiceRequest.performerType Base preferred Practitioner Role ⏿1.0.2 tx.hl7.org.au
    ServiceRequest.reasonCode Base preferred Reason for Request ⏿1.0.1 tx.hl7.org.au
    ServiceRequest.bodySite Base preferred Body Site ⏿1.0.2 tx.hl7.org.au

    Constraints

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

    Differential View

    This structure is derived from ServiceRequest

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest 0..* ServiceRequest Deprecated: A diagnostic service request in an Australian healthcare context
    ServiceRequest.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ServiceRequest.Slices for extension.extension:targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
    URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
    ServiceRequest.identifier 0..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
    ServiceRequest.code 0..1 CodeableConcept What is being requested/ordered
    Binding: Evaluation Procedure (example)
    ServiceRequest.requester 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
    ServiceRequest.performerType 0..1 CodeableConcept Performer role
    Binding: Practitioner Role (preferred)
    ServiceRequest.reasonCode 0..* CodeableConcept Explanation/Justification for procedure or service
    Binding: Reason for Request (preferred)
    ServiceRequest.specimen 0..* Reference(AU Base Specimen) Procedure Samples
    ServiceRequest.bodySite 0..* CodeableConcept Location on Body
    Binding: Body Site (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    ServiceRequest.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au
    ServiceRequest.performerType Base preferred Practitioner Role ⏿1.0.2 tx.hl7.org.au
    ServiceRequest.reasonCode Base preferred Reason for Request ⏿1.0.1 tx.hl7.org.au
    ServiceRequest.bodySite Base preferred Body Site ⏿1.0.2 tx.hl7.org.au

    Snapshot ViewView

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    ServiceRequest C 0..* ServiceRequest Deprecated: A diagnostic service request in an Australian healthcare context
    Constraints: prr-1
    ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
    ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    ServiceRequest.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ServiceRequest.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ServiceRequest.contained 0..* Resource Contained, inline Resources
    ServiceRequest.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ServiceRequest.Slices for extension.extension:targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
    URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
    ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    ServiceRequest.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AULocalOrderIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Identifiers assigned to this order
    ServiceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
    ServiceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
    ServiceRequest.basedOn This element is included in summaries. 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
    ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
    ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Composite Request ID
    ServiceRequest.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
    Binding: RequestStatus (required): The status of a service order.
    ServiceRequest.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    Binding: RequestIntent (required): The kind of service request.
    ServiceRequest.category This element is included in summaries. 0..* CodeableConcept Classification of service
    Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
    ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
    Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
    ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
    ServiceRequest.code This element is included in summaries. 0..1 CodeableConcept What is being requested/ordered
    Binding: Evaluation Procedure (example)
    ServiceRequest.orderDetail This element is included in summaries. C 0..* CodeableConcept Additional order information
    Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
    ServiceRequest.quantity[x] This element is included in summaries. 0..1 Service amount
    ServiceRequest.quantity[x].quantityQuantity Quantity
    ServiceRequest.quantity[x].quantityRatio Ratio
    ServiceRequest.quantity[x].quantityRange Range
    ServiceRequest.subject This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
    ServiceRequest.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter in which the request was created
    ServiceRequest.occurrence[x] This element is included in summaries. 0..1 When service should occur
    ServiceRequest.occurrence[x].occurrenceDateTime dateTime
    ServiceRequest.occurrence[x].occurrencePeriod Period
    ServiceRequest.occurrence[x].occurrenceTiming Timing
    ServiceRequest.asNeeded[x] This element is included in summaries. 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.
    ServiceRequest.asNeeded[x].asNeededBoolean boolean
    ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
    ServiceRequest.authoredOn This element is included in summaries. 0..1 dateTime Date request signed
    ServiceRequest.requester This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
    ServiceRequest.performerType This element is included in summaries. 0..1 CodeableConcept Performer role
    Binding: Practitioner Role (preferred)
    ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
    ServiceRequest.locationCode This element is included in summaries. 0..* CodeableConcept Requested location
    Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
    ServiceRequest.locationReference This element is included in summaries. 0..* Reference(Location) Requested location
    ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
    Binding: Reason for Request (preferred)
    ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
    ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
    ServiceRequest.supportingInfo 0..* Reference(Resource) Additional clinical information
    ServiceRequest.specimen This element is included in summaries. 0..* Reference(AU Base Specimen) Procedure Samples
    ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
    Binding: Body Site (preferred)
    ServiceRequest.note 0..* Annotation Comments
    ServiceRequest.patientInstruction This element is included in summaries. 0..1 string Patient or consumer-oriented instructions
    ServiceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
    ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
    ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
    ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
    ServiceRequest.code Base example Evaluation Procedure ⏿1.0.0 tx.hl7.org.au
    ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
    ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
    ServiceRequest.performerType Base preferred Practitioner Role ⏿1.0.2 tx.hl7.org.au
    ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.5
    ServiceRequest.reasonCode Base preferred Reason for Request ⏿1.0.1 tx.hl7.org.au
    ServiceRequest.bodySite Base preferred Body Site ⏿1.0.2 tx.hl7.org.au

    Constraints

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

    This structure is derived from ServiceRequest

    Summary

    Structures

    This structure refers to these other structures:

    Extensions

    This structure refers to these extensions:

    Maturity: 1

     

    Other representations of profile: CSV, Excel, Schematron