AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 4.2.1-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
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-diagnosticrequest | Version: 4.2.1-ci-build | |||
| Standards status: Trial-use | 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.
Profile specific implementation guidance:
ServiceRequest.code andServiceRequest.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.Extensions under consideration:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context | |
  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 | |
 identifier | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order | |
 code | 0..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure  (example) | |
 requester | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) | |
| performerType | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | |
| reasonCode | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) | |
| specimen | 0..* | Reference(AU Base Specimen) | Procedure Samples | |
 bodySite | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | example | EvaluationProcedure https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | |
| ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
| ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| ServiceRequest.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context 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 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 | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order | |
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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. |
| doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure (example) |
| subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) |
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) |
| reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) |
| specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples |
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | EvaluationProcedure https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | |
| ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
| ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| ServiceRequest.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context 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.
| |||||
| 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 | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||
| 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 | Σ | 0..1 | Identifier | Composite Request ID | ||||
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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. | ||||
| category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| 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 | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure (example) | ||||
| 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 | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | ||||
| 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 | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | ||||
| 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 | Σ | 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 | 0..* | Reference(Resource) | 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 | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://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.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | EvaluationProcedure https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom 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 | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context | |
| 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 | |
| identifier | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order | |
| code | 0..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure (example) | |
| requester | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) | |
| performerType | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | |
| reasonCode | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) | |
| specimen | 0..* | Reference(AU Base Specimen) | Procedure Samples | |
| bodySite | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | example | EvaluationProcedure https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | |
| ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
| ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| ServiceRequest.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context 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 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 | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order | |
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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. |
| doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure (example) |
| subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) |
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) |
| reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred) |
| specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples |
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | EvaluationProcedure https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | |
| ServiceRequest.performerType | preferred | PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | |
| ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| ServiceRequest.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context 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.
| |||||
| 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 | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||
| 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 | Σ | 0..1 | Identifier | Composite Request ID | ||||
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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. | ||||
| category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| 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 | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure (example) | ||||
| 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 | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | ||||
| 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 | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | ||||
| 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 | Σ | 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 | 0..* | Reference(Resource) | 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 | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://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.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | EvaluationProcedure https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom 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 | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| 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
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.2.1-ci-build based on FHIR 4.0.1. Generated 2024-03-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change