STARS Implementation Guide
0.6.1 - release

This page is part of the Csiro Stars (v0.6.1: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: CSIRO STARS ServiceRequest Profile

Official URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-servicerequest Version: 0.6.1
Computable Name: CsiroStarsServiceRequestProfile

A Service Request, no changes yet

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:submissionCategory S 1..1 CodeableConcept Submission Category
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category
Binding: STARS Submission Category ValueSet (required)
... identifier Σ 1..1 Identifier Identifiers assigned to this order
... replaces Σ 0..* Reference(CSIRO STARS ServiceRequest Profile) What request replaces
... requisition SΣ 1..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order +
Binding: RequestIntent (required): The kind of service request.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... subject Σ 1..1 Reference(CSIRO STARS Patient Profile | Group | Location) Individual or Entity the service is ordered for
... authoredOn SΣ 1..1 dateTime Date request signed
... requester SΣ 0..1 Reference(CSIRO STARS Practitioner Profile) Who/what is requesting service
... reason SΣ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes
... supportingInfo S 0..1 CodeableReference(Resource) Additional clinical information
... specimen Σ 1..* Reference(CSIRO STARS Specimen Profile) Procedure Samples

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍5.0.0 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍5.0.0 FHIR Std.
ServiceRequest.priority Base required RequestPriority 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdystr-1 error ServiceRequest bodyStructure SHALL only be present if bodySite is not present bodySite.exists() implies bodyStructure.empty()
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:submissionCategory S 1..1 CodeableConcept Submission Category
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category
Binding: STARS Submission Category ValueSet (required)
... identifier 1..1 Identifier Identifiers assigned to this order
... instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
... instantiatesUri 0..0 Instantiates external protocol or definition
... basedOn 0..0 What request fulfills
... replaces 0..* Reference(CSIRO STARS ServiceRequest Profile) What request replaces
... requisition S 1..1 Identifier Composite Request ID
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S 1..1 code proposal | plan | directive | order +
... category 0..0 Classification of service
... priority S 0..1 code routine | urgent | asap | stat
... doNotPerform 0..0 True if service/procedure should not be performed
... orderDetail 0..0 Additional order information
... quantity[x] 0..0 Service amount
... subject 1..1 Reference(CSIRO STARS Patient Profile | Group | Location) Individual or Entity the service is ordered for
... occurrence[x] 0..0 When service should occur
... asNeeded[x] 0..0 Preconditions for service
... authoredOn S 1..1 dateTime Date request signed
... requester S 0..1 Reference(CSIRO STARS Practitioner Profile) Who/what is requesting service
... performerType 0..0 Performer role
... performer 0..0 Requested performer
... reason S 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
... insurance 0..0 Associated insurance coverage
... supportingInfo S 0..1 CodeableReference(Resource) Additional clinical information
... specimen 1..* Reference(CSIRO STARS Specimen Profile) Procedure Samples
... bodySite 0..0 Coded location on Body
... patientInstruction 0..0 Patient or consumer-oriented instructions
... relevantHistory 0..0 Request provenance

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1
... 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
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:submissionCategory S 1..1 CodeableConcept Submission Category
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category
Binding: STARS Submission Category ValueSet (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Identifiers assigned to this order
... replaces Σ 0..* Reference(CSIRO STARS ServiceRequest Profile) What request replaces
... requisition SΣ 1..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order +
Binding: RequestIntent (required): The kind of service request.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... code ΣC 0..1 CodeableReference(ActivityDefinition | PlanDefinition) ​What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
... subject Σ 1..1 Reference(CSIRO STARS Patient Profile | Group | Location) Individual or Entity the service is ordered for
... focus Σ 0..* Reference(Resource) What the service request is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Encounter in which the request was created
... authoredOn SΣ 1..1 dateTime Date request signed
... requester SΣ 0..1 Reference(CSIRO STARS Practitioner Profile) Who/what is requesting service
... location Σ 0..* CodeableReference(Location) Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... reason SΣ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes
... supportingInfo S 0..1 CodeableReference(Resource) Additional clinical information
... specimen Σ 1..* Reference(CSIRO STARS Specimen Profile) Procedure Samples
... bodyStructure ΣC 0..1 Reference(BodyStructure) BodyStructure-based location on the body
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base required All Languages 📍5.0.0 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍5.0.0 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍5.0.0 FHIR Std.
ServiceRequest.priority Base required RequestPriority 📍5.0.0 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.location Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
ServiceRequest.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdystr-1 error ServiceRequest bodyStructure SHALL only be present if bodySite is not present bodySite.exists() implies bodyStructure.empty()
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:submissionCategory S 1..1 CodeableConcept Submission Category
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category
Binding: STARS Submission Category ValueSet (required)
... identifier Σ 1..1 Identifier Identifiers assigned to this order
... replaces Σ 0..* Reference(CSIRO STARS ServiceRequest Profile) What request replaces
... requisition SΣ 1..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order +
Binding: RequestIntent (required): The kind of service request.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... subject Σ 1..1 Reference(CSIRO STARS Patient Profile | Group | Location) Individual or Entity the service is ordered for
... authoredOn SΣ 1..1 dateTime Date request signed
... requester SΣ 0..1 Reference(CSIRO STARS Practitioner Profile) Who/what is requesting service
... reason SΣ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes
... supportingInfo S 0..1 CodeableReference(Resource) Additional clinical information
... specimen Σ 1..* Reference(CSIRO STARS Specimen Profile) Procedure Samples

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍5.0.0 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍5.0.0 FHIR Std.
ServiceRequest.priority Base required RequestPriority 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdystr-1 error ServiceRequest bodyStructure SHALL only be present if bodySite is not present bodySite.exists() implies bodyStructure.empty()
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:submissionCategory S 1..1 CodeableConcept Submission Category
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category
Binding: STARS Submission Category ValueSet (required)
... identifier 1..1 Identifier Identifiers assigned to this order
... instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
... instantiatesUri 0..0 Instantiates external protocol or definition
... basedOn 0..0 What request fulfills
... replaces 0..* Reference(CSIRO STARS ServiceRequest Profile) What request replaces
... requisition S 1..1 Identifier Composite Request ID
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S 1..1 code proposal | plan | directive | order +
... category 0..0 Classification of service
... priority S 0..1 code routine | urgent | asap | stat
... doNotPerform 0..0 True if service/procedure should not be performed
... orderDetail 0..0 Additional order information
... quantity[x] 0..0 Service amount
... subject 1..1 Reference(CSIRO STARS Patient Profile | Group | Location) Individual or Entity the service is ordered for
... occurrence[x] 0..0 When service should occur
... asNeeded[x] 0..0 Preconditions for service
... authoredOn S 1..1 dateTime Date request signed
... requester S 0..1 Reference(CSIRO STARS Practitioner Profile) Who/what is requesting service
... performerType 0..0 Performer role
... performer 0..0 Requested performer
... reason S 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
... insurance 0..0 Associated insurance coverage
... supportingInfo S 0..1 CodeableReference(Resource) Additional clinical information
... specimen 1..* Reference(CSIRO STARS Specimen Profile) Procedure Samples
... bodySite 0..0 Coded location on Body
... patientInstruction 0..0 Patient or consumer-oriented instructions
... relevantHistory 0..0 Request provenance

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: bdystr-1, prr-1
... 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
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:submissionCategory S 1..1 CodeableConcept Submission Category
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category
Binding: STARS Submission Category ValueSet (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Identifiers assigned to this order
... replaces Σ 0..* Reference(CSIRO STARS ServiceRequest Profile) What request replaces
... requisition SΣ 1..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order +
Binding: RequestIntent (required): The kind of service request.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... code ΣC 0..1 CodeableReference(ActivityDefinition | PlanDefinition) ​What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
... subject Σ 1..1 Reference(CSIRO STARS Patient Profile | Group | Location) Individual or Entity the service is ordered for
... focus Σ 0..* Reference(Resource) What the service request is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Encounter in which the request was created
... authoredOn SΣ 1..1 dateTime Date request signed
... requester SΣ 0..1 Reference(CSIRO STARS Practitioner Profile) Who/what is requesting service
... location Σ 0..* CodeableReference(Location) Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... reason SΣ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes
... supportingInfo S 0..1 CodeableReference(Resource) Additional clinical information
... specimen Σ 1..* Reference(CSIRO STARS Specimen Profile) Procedure Samples
... bodyStructure ΣC 0..1 Reference(BodyStructure) BodyStructure-based location on the body
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base required All Languages 📍5.0.0 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍5.0.0 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍5.0.0 FHIR Std.
ServiceRequest.priority Base required RequestPriority 📍5.0.0 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.location Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
ServiceRequest.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdystr-1 error ServiceRequest bodyStructure SHALL only be present if bodySite is not present bodySite.exists() implies bodyStructure.empty()
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

 

Other representations of profile: CSV, Excel, Schematron