STARS Implementation Guide
0.1.0 - ci-build
STARS Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Official URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-servicerequest | Version: 0.1.0 | |||
Draft as of 2023-04-26 | Computable Name: CsiroStarsServiceRequestProfile |
A Service Request, no changes yet
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 request for a service to be performed | |
language | 0..0 | |||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
submissionCategory | 1..1 | CodeableConcept | Submission Category URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category Binding: STARS Submission Category Value Set (required) | |
identifier | 1..1 | Identifier | Identifiers assigned to this order | |
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | 0..0 | |||
replaces | 0..* | Reference(CSIRO STARS ServiceRequest Profile) | What request replaces | |
requisition | 1..1 | Identifier | Composite Request ID | |
category | 0..0 | |||
doNotPerform | 0..0 | |||
orderDetail | 0..0 | |||
quantity[x] | 0..0 | |||
subject | 1..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | Individual or Entity the service is ordered for | |
occurrence[x] | 0..0 | |||
asNeeded[x] | 0..0 | |||
authoredOn | 1..1 | dateTime | Date request signed | |
requester | 0..1 | Reference(Practitioner | PractitionerRole | CSIRO STARS Organization Profile | CSIRO STARS Patient Profile | RelatedPerson | Device) | Who/what is requesting service | |
performerType | 0..0 | |||
performer | 0..0 | |||
insurance | 0..0 | |||
supportingInfo | 0..1 | Reference(Resource) | Additional clinical information | |
specimen | 1..* | Reference(CSIRO STARS Specimen Profile) | Procedure Samples | |
bodySite | 0..0 | |||
patientInstruction | 0..0 | |||
relevantHistory | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
submissionCategory | 1..1 | CodeableConcept | Submission Category URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category Binding: STARS Submission Category Value Set (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 | Σ | 1..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. |
subject | Σ | 1..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | Individual or Entity the service is ordered for |
authoredOn | Σ | 1..1 | dateTime | Date request signed |
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | CSIRO STARS Organization Profile | CSIRO STARS Patient Profile | RelatedPerson | Device) | Who/what is requesting service |
supportingInfo | 0..1 | Reference(Resource) | Additional clinical information | |
specimen | Σ | 1..* | Reference(CSIRO STARS Specimen Profile) | Procedure Samples |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | RequestIntent |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
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 | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
submissionCategory | 1..1 | CodeableConcept | Submission Category URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category Binding: STARS Submission Category Value Set (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 | Σ | 1..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. |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
code | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (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. |
subject | Σ | 1..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | Individual or Entity the service is ordered for |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created |
authoredOn | Σ | 1..1 | dateTime | Date request signed |
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | CSIRO STARS Organization Profile | CSIRO STARS Patient Profile | RelatedPerson | Device) | Who/what is requesting service |
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: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes |
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
supportingInfo | 0..1 | Reference(Resource) | Additional clinical information | |
specimen | Σ | 1..* | Reference(CSIRO STARS Specimen Profile) | Procedure Samples |
note | 0..* | Annotation | Comments | |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | RequestIntent |
ServiceRequest.priority | required | RequestPriority |
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType |
ServiceRequest.reasonCode | example | ProcedureReasonCodes |
This structure is derived from ServiceRequest
Summary
Mandatory: 6 elements
Prohibited: 16 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
language | 0..0 | |||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
submissionCategory | 1..1 | CodeableConcept | Submission Category URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category Binding: STARS Submission Category Value Set (required) | |
identifier | 1..1 | Identifier | Identifiers assigned to this order | |
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | 0..0 | |||
replaces | 0..* | Reference(CSIRO STARS ServiceRequest Profile) | What request replaces | |
requisition | 1..1 | Identifier | Composite Request ID | |
category | 0..0 | |||
doNotPerform | 0..0 | |||
orderDetail | 0..0 | |||
quantity[x] | 0..0 | |||
subject | 1..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | Individual or Entity the service is ordered for | |
occurrence[x] | 0..0 | |||
asNeeded[x] | 0..0 | |||
authoredOn | 1..1 | dateTime | Date request signed | |
requester | 0..1 | Reference(Practitioner | PractitionerRole | CSIRO STARS Organization Profile | CSIRO STARS Patient Profile | RelatedPerson | Device) | Who/what is requesting service | |
performerType | 0..0 | |||
performer | 0..0 | |||
insurance | 0..0 | |||
supportingInfo | 0..1 | Reference(Resource) | Additional clinical information | |
specimen | 1..* | Reference(CSIRO STARS Specimen Profile) | Procedure Samples | |
bodySite | 0..0 | |||
patientInstruction | 0..0 | |||
relevantHistory | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
submissionCategory | 1..1 | CodeableConcept | Submission Category URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category Binding: STARS Submission Category Value Set (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 | Σ | 1..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. |
subject | Σ | 1..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | Individual or Entity the service is ordered for |
authoredOn | Σ | 1..1 | dateTime | Date request signed |
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | CSIRO STARS Organization Profile | CSIRO STARS Patient Profile | RelatedPerson | Device) | Who/what is requesting service |
supportingInfo | 0..1 | Reference(Resource) | Additional clinical information | |
specimen | Σ | 1..* | Reference(CSIRO STARS Specimen Profile) | Procedure Samples |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | RequestIntent |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
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 | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
submissionCategory | 1..1 | CodeableConcept | Submission Category URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-submission-category Binding: STARS Submission Category Value Set (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 | Σ | 1..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. |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
code | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (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. |
subject | Σ | 1..1 | Reference(CSIRO STARS Patient Profile | Group | Location) | Individual or Entity the service is ordered for |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created |
authoredOn | Σ | 1..1 | dateTime | Date request signed |
requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | CSIRO STARS Organization Profile | CSIRO STARS Patient Profile | RelatedPerson | Device) | Who/what is requesting service |
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: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes |
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
supportingInfo | 0..1 | Reference(Resource) | Additional clinical information | |
specimen | Σ | 1..* | Reference(CSIRO STARS Specimen Profile) | Procedure Samples |
note | 0..* | Annotation | Comments | |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | RequestIntent |
ServiceRequest.priority | required | RequestPriority |
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType |
ServiceRequest.reasonCode | example | ProcedureReasonCodes |
This structure is derived from ServiceRequest
Summary
Mandatory: 6 elements
Prohibited: 16 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron