CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• JSON

Resource Profile: ServiceRequestReferral

Introduction

The ServiceRequestReferral profile is used for retrieving data about a referral request. This profile is based on the FHIR resource ServiceRequest. It includes information like referral date, requester, receiver and also references a Composition resource with referral record data.

Intended Use

The intended use for this API is to get information about a patient's referral requests, both ongoing and completed. The referrals with accompanied data such as assessments and answers can be retrieved when the external system user is the patient to which record the data belongs.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/ServiceRequest/[id] (Read)
2. GET [baseURL]/ServiceRequest/subject= (Search)
3. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;subject (Search)
4. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;requester (Search)
5. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;requester.practitioner (Search)
6. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;requester.organization (Search)
7. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;performer (Search)
8. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;performer.practitioner (Search)
9. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;performer.organization (Search)
10. GET [baseURL]/ServiceRequest/subject=[id]&_revinclude=Task;focus (Search)

Error codes

No specific error codes for ServiceRequest.

Usages:

• Refer to this Profile: TaskReferral
• Examples for this Profile: ServiceRequest/154402
• CapabilityStatements using this Profile: Cambio Open Services

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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ServiceRequest	C	0..*	ServiceRequestReferralCoreSwe	A request for a service to be performed Constraints: prr-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Identifiers assigned to this order Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:localServiceRequest	Σ	0..1	Identifier	Identifiers assigned to this order
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.cambio.se/ServiceRequest
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:nationalServiceRequest	Σ	0..1	Identifier	Identifiers assigned to this order
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://cambio.codes/is/inera/national-referral-id
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	1..1	code	draft | active | revoked | completed | entered-in-error Binding: RequestStatus (required): The status of a service order.
intent	?!Σ	1..1	code	order Binding: RequestIntent (required): The kind of service request. Fixed Value: order
category	Σ	1..1	CodeableConcept	Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 3457005
code	Σ	1..1	CodeableConcept	What is being requested/ordered Binding: ReferralRequestTypes (required): Codes for referral request types
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
subject	Σ	1..1	Reference(Patient)	Individual or Entity the service is ordered for
encounter	Σ	0..1	Reference(Encounter)	Encounter in which the request was created
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): A resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
authoredOn	Σ	1..1	dateTime	Date request
requester	Σ	1..1	Reference(PractitionerRoleLiteSe | Patient | Organization | Practitioner)	Who/what is requesting service
performer	Σ	0..1	Reference(PractitionerRoleLiteSe | Organization | Practitioner)	Requested performer
reasonCode	Σ	0..1	CodeableConcept	Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
supportingInfo		0..1	Reference(CompositionReferralClinicalInformation)	Additional clinical information
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ServiceRequest.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier:localServiceRequest.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier:nationalServiceRequest.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
ServiceRequest.intent	required	Fixed Value: order http://hl7.org/fhir/ValueSet/request-intent|4.0.1 From the FHIR Standard
ServiceRequest.category	example	ServiceRequestCategoryCodes http://hl7.org/fhir/ValueSet/servicerequest-category From the FHIR Standard
ServiceRequest.code	required	ReferralRequestTypes https://fhir.cambio.se/ValueSet/ReferralRequestTypes/v1 From this IG
ServiceRequest.encounter.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
ServiceRequest.reasonCode	example	ProcedureReasonCodes http://hl7.org/fhir/ValueSet/procedure-reason From the FHIR Standard

Constraints

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 ServiceRequestReferralCoreSwe

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ServiceRequest		0..*	ServiceRequestReferralCoreSwe	A request for a service to be performed
Slices for identifier		0..*	Identifier	Identifiers assigned to this order Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
identifier:localServiceRequest		0..1	Identifier	Identifiers assigned to this order
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.cambio.se/ServiceRequest
identifier:nationalServiceRequest		0..1	Identifier	Identifiers assigned to this order
system		1..1	uri	The namespace for the identifier value Fixed Value: https://cambio.codes/is/inera/national-referral-id
instantiatesCanonical		0..0
instantiatesUri		0..0
basedOn		0..0
replaces		0..0
requisition		0..0
status		1..1	code	draft | active | revoked | completed | entered-in-error
intent		1..1	code	order Fixed Value: order
category		1..1	CodeableConcept	Classification of service
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
priority		0..0
code		1..1	CodeableConcept	What is being requested/ordered Binding: ReferralRequestTypes (required): Codes for referral request types
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
orderDetail		0..0
encounter		0..1	Reference(Encounter)	Encounter in which the request was created
type		0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): A resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
identifier
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
occurrence[x]		0..0
authoredOn		1..1	dateTime	Date request
requester		1..1	Reference(PractitionerRoleLiteSe | Patient | Organization | Practitioner)	Who/what is requesting service
performerType		0..0
performer		0..1	Reference(PractitionerRoleLiteSe | Organization | Practitioner)	Requested performer
reasonCode		0..1	CodeableConcept	Explanation/Justification for procedure or service
reasonReference		0..0
insurance		0..0
supportingInfo		0..1	Reference(CompositionReferralClinicalInformation)	Additional clinical information
note		0..0
patientInstruction		0..0
relevantHistory		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
ServiceRequest.code	required	ReferralRequestTypes https://fhir.cambio.se/ValueSet/ReferralRequestTypes/v1 From this IG
ServiceRequest.encounter.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ServiceRequest	C	0..*	ServiceRequestReferralCoreSwe	A request for a service to be performed 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 Bindings Purpose 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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Identifiers assigned to this order Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:localServiceRequest	Σ	0..1	Identifier	Identifiers assigned to this order
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	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.cambio.se/ServiceRequest
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:nationalServiceRequest	Σ	0..1	Identifier	Identifiers assigned to this order
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	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://cambio.codes/is/inera/national-referral-id
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!Σ	1..1	code	draft | active | revoked | completed | entered-in-error Binding: RequestStatus (required): The status of a service order.
intent	?!Σ	1..1	code	order Binding: RequestIntent (required): The kind of service request. Fixed Value: order
category	Σ	1..1	CodeableConcept	Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
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 Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 3457005
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
code	Σ	1..1	CodeableConcept	What is being requested/ordered Binding: ReferralRequestTypes (required): Codes for referral request types
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
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
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
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
subject	Σ	1..1	Reference(Patient)	Individual or Entity the service is ordered for
encounter	Σ	0..1	Reference(Encounter)	Encounter in which the request was created
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): A resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
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	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
authoredOn	Σ	1..1	dateTime	Date request
requester	Σ	1..1	Reference(PractitionerRoleLiteSe | Patient | Organization | Practitioner)	Who/what is requesting service
performer	Σ	0..1	Reference(PractitionerRoleLiteSe | Organization | Practitioner)	Requested performer
reasonCode	Σ	0..1	CodeableConcept	Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
supportingInfo		0..1	Reference(CompositionReferralClinicalInformation)	Additional clinical information
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ServiceRequest.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ServiceRequest.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
ServiceRequest.identifier:localServiceRequest.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier:localServiceRequest.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
ServiceRequest.identifier:nationalServiceRequest.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier:nationalServiceRequest.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
ServiceRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
ServiceRequest.intent	required	Fixed Value: order http://hl7.org/fhir/ValueSet/request-intent|4.0.1 From the FHIR Standard
ServiceRequest.category	example	ServiceRequestCategoryCodes http://hl7.org/fhir/ValueSet/servicerequest-category From the FHIR Standard
ServiceRequest.code	required	ReferralRequestTypes https://fhir.cambio.se/ValueSet/ReferralRequestTypes/v1 From this IG
ServiceRequest.encounter.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
ServiceRequest.encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.encounter.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
ServiceRequest.reasonCode	example	ProcedureReasonCodes http://hl7.org/fhir/ValueSet/procedure-reason From the FHIR Standard

Constraints

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 ServiceRequestReferralCoreSwe

Summary

Mandatory: 10 elements(6 nested mandatory elements)
Fixed: 5 elements
Prohibited: 15 elements

Structures

This structure refers to these other structures:

• PractitionerRoleLiteSe (https://fhir.cambio.se/StructureDefinition/PractitionerRoleLiteSe/v1)
• CompositionReferralClinicalInformation (https://fhir.cambio.se/StructureDefinition/CompositionReferralClinicalInformation/v1)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of ServiceRequest.identifier

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ServiceRequest	C	0..*	ServiceRequestReferralCoreSwe	A request for a service to be performed Constraints: prr-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Identifiers assigned to this order Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:localServiceRequest	Σ	0..1	Identifier	Identifiers assigned to this order
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.cambio.se/ServiceRequest
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:nationalServiceRequest	Σ	0..1	Identifier	Identifiers assigned to this order
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://cambio.codes/is/inera/national-referral-id
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	1..1	code	draft | active | revoked | completed | entered-in-error Binding: RequestStatus (required): The status of a service order.
intent	?!Σ	1..1	code	order Binding: RequestIntent (required): The kind of service request. Fixed Value: order
category	Σ	1..1	CodeableConcept	Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 3457005
code	Σ	1..1	CodeableConcept	What is being requested/ordered Binding: ReferralRequestTypes (required): Codes for referral request types
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
subject	Σ	1..1	Reference(Patient)	Individual or Entity the service is ordered for
encounter	Σ	0..1	Reference(Encounter)	Encounter in which the request was created
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): A resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
authoredOn	Σ	1..1	dateTime	Date request
requester	Σ	1..1	Reference(PractitionerRoleLiteSe | Patient | Organization | Practitioner)	Who/what is requesting service
performer	Σ	0..1	Reference(PractitionerRoleLiteSe | Organization | Practitioner)	Requested performer
reasonCode	Σ	0..1	CodeableConcept	Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
supportingInfo		0..1	Reference(CompositionReferralClinicalInformation)	Additional clinical information
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ServiceRequest.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier:localServiceRequest.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier:nationalServiceRequest.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
ServiceRequest.intent	required	Fixed Value: order http://hl7.org/fhir/ValueSet/request-intent|4.0.1 From the FHIR Standard
ServiceRequest.category	example	ServiceRequestCategoryCodes http://hl7.org/fhir/ValueSet/servicerequest-category From the FHIR Standard
ServiceRequest.code	required	ReferralRequestTypes https://fhir.cambio.se/ValueSet/ReferralRequestTypes/v1 From this IG
ServiceRequest.encounter.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
ServiceRequest.reasonCode	example	ProcedureReasonCodes http://hl7.org/fhir/ValueSet/procedure-reason From the FHIR Standard

Constraints

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()

Differential View

This structure is derived from ServiceRequestReferralCoreSwe

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ServiceRequest		0..*	ServiceRequestReferralCoreSwe	A request for a service to be performed
Slices for identifier		0..*	Identifier	Identifiers assigned to this order Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
identifier:localServiceRequest		0..1	Identifier	Identifiers assigned to this order
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.cambio.se/ServiceRequest
identifier:nationalServiceRequest		0..1	Identifier	Identifiers assigned to this order
system		1..1	uri	The namespace for the identifier value Fixed Value: https://cambio.codes/is/inera/national-referral-id
instantiatesCanonical		0..0
instantiatesUri		0..0
basedOn		0..0
replaces		0..0
requisition		0..0
status		1..1	code	draft | active | revoked | completed | entered-in-error
intent		1..1	code	order Fixed Value: order
category		1..1	CodeableConcept	Classification of service
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
priority		0..0
code		1..1	CodeableConcept	What is being requested/ordered Binding: ReferralRequestTypes (required): Codes for referral request types
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
orderDetail		0..0
encounter		0..1	Reference(Encounter)	Encounter in which the request was created
type		0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): A resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
identifier
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
occurrence[x]		0..0
authoredOn		1..1	dateTime	Date request
requester		1..1	Reference(PractitionerRoleLiteSe | Patient | Organization | Practitioner)	Who/what is requesting service
performerType		0..0
performer		0..1	Reference(PractitionerRoleLiteSe | Organization | Practitioner)	Requested performer
reasonCode		0..1	CodeableConcept	Explanation/Justification for procedure or service
reasonReference		0..0
insurance		0..0
supportingInfo		0..1	Reference(CompositionReferralClinicalInformation)	Additional clinical information
note		0..0
patientInstruction		0..0
relevantHistory		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
ServiceRequest.code	required	ReferralRequestTypes https://fhir.cambio.se/ValueSet/ReferralRequestTypes/v1 From this IG
ServiceRequest.encounter.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ServiceRequest	C	0..*	ServiceRequestReferralCoreSwe	A request for a service to be performed 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 Bindings Purpose 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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Identifiers assigned to this order Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:localServiceRequest	Σ	0..1	Identifier	Identifiers assigned to this order
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	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.cambio.se/ServiceRequest
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:nationalServiceRequest	Σ	0..1	Identifier	Identifiers assigned to this order
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	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://cambio.codes/is/inera/national-referral-id
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!Σ	1..1	code	draft | active | revoked | completed | entered-in-error Binding: RequestStatus (required): The status of a service order.
intent	?!Σ	1..1	code	order Binding: RequestIntent (required): The kind of service request. Fixed Value: order
category	Σ	1..1	CodeableConcept	Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
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 Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 3457005
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
code	Σ	1..1	CodeableConcept	What is being requested/ordered Binding: ReferralRequestTypes (required): Codes for referral request types
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
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
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
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
subject	Σ	1..1	Reference(Patient)	Individual or Entity the service is ordered for
encounter	Σ	0..1	Reference(Encounter)	Encounter in which the request was created
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): A resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
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	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
authoredOn	Σ	1..1	dateTime	Date request
requester	Σ	1..1	Reference(PractitionerRoleLiteSe | Patient | Organization | Practitioner)	Who/what is requesting service
performer	Σ	0..1	Reference(PractitionerRoleLiteSe | Organization | Practitioner)	Requested performer
reasonCode	Σ	0..1	CodeableConcept	Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
supportingInfo		0..1	Reference(CompositionReferralClinicalInformation)	Additional clinical information
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ServiceRequest.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ServiceRequest.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
ServiceRequest.identifier:localServiceRequest.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier:localServiceRequest.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
ServiceRequest.identifier:nationalServiceRequest.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.identifier:nationalServiceRequest.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
ServiceRequest.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard
ServiceRequest.intent	required	Fixed Value: order http://hl7.org/fhir/ValueSet/request-intent|4.0.1 From the FHIR Standard
ServiceRequest.category	example	ServiceRequestCategoryCodes http://hl7.org/fhir/ValueSet/servicerequest-category From the FHIR Standard
ServiceRequest.code	required	ReferralRequestTypes https://fhir.cambio.se/ValueSet/ReferralRequestTypes/v1 From this IG
ServiceRequest.encounter.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
ServiceRequest.encounter.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
ServiceRequest.encounter.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
ServiceRequest.reasonCode	example	ProcedureReasonCodes http://hl7.org/fhir/ValueSet/procedure-reason From the FHIR Standard

Constraints

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 ServiceRequestReferralCoreSwe

Summary

Mandatory: 10 elements(6 nested mandatory elements)
Fixed: 5 elements
Prohibited: 15 elements

Structures

This structure refers to these other structures:

• PractitionerRoleLiteSe (https://fhir.cambio.se/StructureDefinition/PractitionerRoleLiteSe/v1)
• CompositionReferralClinicalInformation (https://fhir.cambio.se/StructureDefinition/CompositionReferralClinicalInformation/v1)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of ServiceRequest.identifier

Other representations of profile: CSV, Excel, Schematron