Magentus Practice Management FHIR Implementation Guide
1.2.60 - ci-build Australia flag

Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.60) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Referral Request

Official URL: http://fhir.geniesolutions.io/StructureDefinition/gs-referral-request Version: 1.2.60
Active as of 2026-04-05 Computable Name: GSReferralRequest

Magentus Referral Request for a clinical referral to a specialist.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* AUBaseDiagnosticRequest A diagnostic service request in an Australian healthcare context
Constraints: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension: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
... Slices for identifier 1..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:placer S 1..1 AULocalOrderIdentifier PMS assigned request identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
Binding: Order Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PLAC
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri System identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Order identifier
Example General: 123456
..... assigner Σ 1..1 Reference(Organization) Organisation that assigned the order identifier
...... display Σ 1..1 string Name of the assigning organisation
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
Required Pattern: active
... 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.
Required Pattern: order
... category SΣ 0..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... 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)
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:patientrefferal SΣ 0..1 Coding Patient referral
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
...... display Σ 0..1 string Representation defined by the system
Required Pattern: Patient referral
.... text Σ 0..1 string Description of service being ordered
... subject SΣ 1..1 Reference(Genie Patient) Individual or Entity the service is ordered for
... authoredOn SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(Genie PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... performer SΣ 0..1 Reference(Genie PractitionerRole | Genie Organization | Genie HealthcareService) Requested performer
... reasonCode SΣ 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
... reasonReference SΣ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Genie Coverage) Reference to Coverage resource for funding type
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by type:$this.resolve()
.... supportingInfo:condition S 0..* Reference(AU Core Condition) Additional clinical information
.... supportingInfo:observation S 0..* Reference(AU Core Observation) Additional clinical information
.... supportingInfo:procedure S 0..* Reference(AU Core Procedure) Additional clinical information
.... supportingInfo:allergy S 0..* Reference(AU Core AllergyIntolerance) Additional clinical information
.... supportingInfo:medication S 0..* Reference(AU Core MedicationStatement) Additional clinical information
.... supportingInfo:paper S 0..1 Reference(Binary) Additional clinical information

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.identifier:placer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:placer.​type Base required Order Identifier Type 📦4.1.2-preview AU Base Implementation Guide v4.1
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.code Base example Evaluation Procedure . ⏿1.0.0 tx.hl7.org.au
ServiceRequest.reasonCode Base preferred Reason for Request . ⏿1.0.1 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 AUBaseDiagnosticRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* AUBaseDiagnosticRequest A diagnostic service request in an Australian healthcare context
... Slices for identifier 1..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:placer S 1..1 AULocalOrderIdentifier PMS assigned request identifier
..... type 1..1 CodeableConcept Coded identifier type for local order identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PLAC
... status 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required Pattern: active
... intent 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... category S 0..1 CodeableConcept Classification of service
... code
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:patientrefferal S 0..1 Coding Patient referral
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... code 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
...... display 0..1 string Representation defined by the system
Required Pattern: Patient referral
.... text 0..1 string Description of service being ordered
... subject S 1..1 Reference(Genie Patient) Individual or Entity the service is ordered for
... authoredOn S 0..1 dateTime Date request signed
... requester S 1..1 Reference(Genie PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... performer S 0..1 Reference(Genie PractitionerRole | Genie Organization | Genie HealthcareService) Requested performer
... reasonCode S 1..* CodeableConcept Explanation/Justification for procedure or service
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Genie Coverage) Reference to Coverage resource for funding type
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by type:$this.resolve()
.... supportingInfo:condition S 0..* Reference(AU Core Condition) Additional clinical information
.... supportingInfo:observation S 0..* Reference(AU Core Observation) Additional clinical information
.... supportingInfo:procedure S 0..* Reference(AU Core Procedure) Additional clinical information
.... supportingInfo:allergy S 0..* Reference(AU Core AllergyIntolerance) Additional clinical information
.... supportingInfo:medication S 0..* Reference(AU Core MedicationStatement) Additional clinical information
.... supportingInfo:paper S 0..1 Reference(Binary) Additional clinical information

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* AUBaseDiagnosticRequest A diagnostic service request in an Australian healthcare context
Constraints: 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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
... Slices for identifier 1..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:placer S 1..1 AULocalOrderIdentifier PMS assigned request identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
Binding: Order Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PLAC
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri System identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Order identifier
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 1..1 Reference(Organization) Organisation that assigned the order identifier
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 1..1 string Name of the assigning organisation
... 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.
Required Pattern: active
... 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.
Required Pattern: order
... category SΣ 0..1 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)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:patientrefferal SΣ 0..1 Coding Patient referral
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
...... display Σ 0..1 string Representation defined by the system
Required Pattern: Patient referral
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Description of service being ordered
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Genie Patient) 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(Genie PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... performerType Σ 0..1 CodeableConcept Performer role
Binding: Practitioner Role . (preferred)
... performer SΣ 0..1 Reference(Genie PractitionerRole | Genie Organization | Genie HealthcareService) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered.
... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode SΣ 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
... reasonReference SΣ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Genie Coverage) Reference to Coverage resource for funding type
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by type:$this.resolve()
.... supportingInfo:condition S 0..* Reference(AU Core Condition) Additional clinical information
.... supportingInfo:observation S 0..* Reference(AU Core Observation) Additional clinical information
.... supportingInfo:procedure S 0..* Reference(AU Core Procedure) Additional clinical information
.... supportingInfo:allergy S 0..* Reference(AU Core AllergyIntolerance) Additional clinical information
.... supportingInfo:medication S 0..* Reference(AU Core MedicationStatement) Additional clinical information
.... supportingInfo:paper S 0..1 Reference(Binary) 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

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.identifier:placer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:placer.​type Base required Order Identifier Type 📦4.1.2-preview AU Base Implementation Guide v4.1
ServiceRequest.identifier:placer.​assigner.type Base extensible ResourceType 📦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.1
ServiceRequest.reasonCode Base preferred Reason for Request . ⏿1.0.1 tx.hl7.org.au
ServiceRequest.insurance.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* AUBaseDiagnosticRequest A diagnostic service request in an Australian healthcare context
Constraints: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension: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
... Slices for identifier 1..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:placer S 1..1 AULocalOrderIdentifier PMS assigned request identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
Binding: Order Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PLAC
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri System identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Order identifier
Example General: 123456
..... assigner Σ 1..1 Reference(Organization) Organisation that assigned the order identifier
...... display Σ 1..1 string Name of the assigning organisation
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
Required Pattern: active
... 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.
Required Pattern: order
... category SΣ 0..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... 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)
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:patientrefferal SΣ 0..1 Coding Patient referral
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
...... display Σ 0..1 string Representation defined by the system
Required Pattern: Patient referral
.... text Σ 0..1 string Description of service being ordered
... subject SΣ 1..1 Reference(Genie Patient) Individual or Entity the service is ordered for
... authoredOn SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(Genie PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... performer SΣ 0..1 Reference(Genie PractitionerRole | Genie Organization | Genie HealthcareService) Requested performer
... reasonCode SΣ 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
... reasonReference SΣ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Genie Coverage) Reference to Coverage resource for funding type
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by type:$this.resolve()
.... supportingInfo:condition S 0..* Reference(AU Core Condition) Additional clinical information
.... supportingInfo:observation S 0..* Reference(AU Core Observation) Additional clinical information
.... supportingInfo:procedure S 0..* Reference(AU Core Procedure) Additional clinical information
.... supportingInfo:allergy S 0..* Reference(AU Core AllergyIntolerance) Additional clinical information
.... supportingInfo:medication S 0..* Reference(AU Core MedicationStatement) Additional clinical information
.... supportingInfo:paper S 0..1 Reference(Binary) Additional clinical information

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.identifier:placer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:placer.​type Base required Order Identifier Type 📦4.1.2-preview AU Base Implementation Guide v4.1
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.code Base example Evaluation Procedure . ⏿1.0.0 tx.hl7.org.au
ServiceRequest.reasonCode Base preferred Reason for Request . ⏿1.0.1 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 AUBaseDiagnosticRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* AUBaseDiagnosticRequest A diagnostic service request in an Australian healthcare context
... Slices for identifier 1..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:placer S 1..1 AULocalOrderIdentifier PMS assigned request identifier
..... type 1..1 CodeableConcept Coded identifier type for local order identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PLAC
... status 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required Pattern: active
... intent 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... category S 0..1 CodeableConcept Classification of service
... code
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:patientrefferal S 0..1 Coding Patient referral
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... code 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
...... display 0..1 string Representation defined by the system
Required Pattern: Patient referral
.... text 0..1 string Description of service being ordered
... subject S 1..1 Reference(Genie Patient) Individual or Entity the service is ordered for
... authoredOn S 0..1 dateTime Date request signed
... requester S 1..1 Reference(Genie PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... performer S 0..1 Reference(Genie PractitionerRole | Genie Organization | Genie HealthcareService) Requested performer
... reasonCode S 1..* CodeableConcept Explanation/Justification for procedure or service
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Genie Coverage) Reference to Coverage resource for funding type
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by type:$this.resolve()
.... supportingInfo:condition S 0..* Reference(AU Core Condition) Additional clinical information
.... supportingInfo:observation S 0..* Reference(AU Core Observation) Additional clinical information
.... supportingInfo:procedure S 0..* Reference(AU Core Procedure) Additional clinical information
.... supportingInfo:allergy S 0..* Reference(AU Core AllergyIntolerance) Additional clinical information
.... supportingInfo:medication S 0..* Reference(AU Core MedicationStatement) Additional clinical information
.... supportingInfo:paper S 0..1 Reference(Binary) Additional clinical information

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* AUBaseDiagnosticRequest A diagnostic service request in an Australian healthcare context
Constraints: 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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
... Slices for identifier 1..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:placer S 1..1 AULocalOrderIdentifier PMS assigned request identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
Binding: Order Identifier Type (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PLAC
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri System identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Order identifier
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 1..1 Reference(Organization) Organisation that assigned the order identifier
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 1..1 string Name of the assigning organisation
... 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.
Required Pattern: active
... 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.
Required Pattern: order
... category SΣ 0..1 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)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:patientrefferal SΣ 0..1 Coding Patient referral
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
...... display Σ 0..1 string Representation defined by the system
Required Pattern: Patient referral
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Description of service being ordered
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Genie Patient) 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(Genie PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
... performerType Σ 0..1 CodeableConcept Performer role
Binding: Practitioner Role . (preferred)
... performer SΣ 0..1 Reference(Genie PractitionerRole | Genie Organization | Genie HealthcareService) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered.
... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode SΣ 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
... reasonReference SΣ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Genie Coverage) Reference to Coverage resource for funding type
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by type:$this.resolve()
.... supportingInfo:condition S 0..* Reference(AU Core Condition) Additional clinical information
.... supportingInfo:observation S 0..* Reference(AU Core Observation) Additional clinical information
.... supportingInfo:procedure S 0..* Reference(AU Core Procedure) Additional clinical information
.... supportingInfo:allergy S 0..* Reference(AU Core AllergyIntolerance) Additional clinical information
.... supportingInfo:medication S 0..* Reference(AU Core MedicationStatement) Additional clinical information
.... supportingInfo:paper S 0..1 Reference(Binary) 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

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.identifier:placer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:placer.​type Base required Order Identifier Type 📦4.1.2-preview AU Base Implementation Guide v4.1
ServiceRequest.identifier:placer.​assigner.type Base extensible ResourceType 📦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.1
ServiceRequest.reasonCode Base preferred Reason for Request . ⏿1.0.1 tx.hl7.org.au
ServiceRequest.insurance.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
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()

 

Other representations of profile: CSV, Excel, Schematron