HL7.FHIR.US.ECR\eICR ServiceRequest

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.0.0 - STU 2

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: eICR ServiceRequest

Defining URL:

http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest

Version:

2.0.0

Name:

Eicr_ServiceRequest

Title:

eICR ServiceRequest

Status:

Active as of 1/18/22 12:57 PM

Definition:

This ServiceRequest profile represents eICR laboratory orders and other diagnostics for the eICR event.

Publisher:

HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from ServiceRequest

Summary

Mandatory: 1 element
Must-Support: 5 elements

This structure is derived from ServiceRequest

Name	Flags	Card.	Type	Description & Constraints
ServiceRequest	S	0..*	ServiceRequest	eICR ServiceRequest
identifier	S	0..*	Identifier	Identifiers assigned to this order
code	S	1..1	CodeableConcept	What is being requested/ordered Binding: LOINCDiagnosticReportCodes (extensible): LOINC Diagnostic Report Codes
subject		1..1	Reference(Patient)	Individual or Entity the service is ordered for
occurrence[x]	S	0..1	dateTime, Period, Timing	When service should occur
authoredOn	S	0..1	dateTime	Date request signed
requester	S	0..1	Reference(Practitioner \| PractitionerRole \| Organization \| Patient \| RelatedPerson \| Device)	Who/what is requesting service
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ServiceRequest	SI	0..*	ServiceRequest	eICR ServiceRequest
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifiers assigned to this order
instantiatesCanonical	Σ	0..*	canonical(ActivityDefinition \| PlanDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn	Σ	0..*	Reference(CarePlan \| ServiceRequest \| MedicationRequest)	What request fulfills
replaces	Σ	0..*	Reference(ServiceRequest)	What request replaces
requisition	Σ	0..1	Identifier	Composite Request ID
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown Binding: RequestStatus (required): The status of a service order.
intent	?!Σ	1..1	code	proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option Binding: RequestIntent (required): The kind of service request.
category	Σ	0..*	CodeableConcept	Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
priority	Σ	0..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
doNotPerform	?!Σ	0..1	boolean	True if service/procedure should not be performed
code	SΣ	1..1	CodeableConcept	What is being requested/ordered Binding: LOINCDiagnosticReportCodes (extensible): LOINC Diagnostic Report Codes
orderDetail	ΣI	0..*	CodeableConcept	Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
quantity[x]	Σ	0..1		Service amount
quantityQuantity			Quantity
quantityRatio			Ratio
quantityRange			Range
subject	Σ	1..1	Reference(Patient)	Individual or Entity the service is ordered for
encounter	Σ	0..1	Reference(Encounter)	Encounter in which the request was created
occurrence[x]	SΣ	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Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization \| Patient \| RelatedPerson \| Device)	Who/what is requesting service
performerType	Σ	0..1	CodeableConcept	Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
performer	Σ	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| HealthcareService \| Patient \| Device \| RelatedPerson)	Requested performer
locationCode	Σ	0..*	CodeableConcept	Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
locationReference	Σ	0..*	Reference(Location)	Requested location
reasonCode	Σ	0..*	CodeableConcept	Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
reasonReference	Σ	0..*	Reference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Explanation/Justification for service or service
insurance		0..*	Reference(Coverage \| ClaimResponse)	Associated insurance coverage
supportingInfo		0..*	Reference(Resource)	Additional clinical information
specimen	Σ	0..*	Reference(Specimen)	Procedure Samples
bodySite	Σ	0..*	CodeableConcept	Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
note		0..*	Annotation	Comments
patientInstruction	Σ	0..1	string	Patient or consumer-oriented instructions
relevantHistory		0..*	Reference(Provenance)	Request provenance
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ServiceRequest	I	0..*	ServiceRequest	eICR ServiceRequest
identifier	Σ	0..*	Identifier	Identifiers assigned to this order
code	Σ	1..1	CodeableConcept	What is being requested/ordered Binding: LOINCDiagnosticReportCodes (extensible): LOINC Diagnostic Report Codes
occurrence[x]	Σ	0..1		When service should occur
occurrenceDateTime			dateTime
occurrencePeriod			Period
occurrenceTiming			Timing
authoredOn	Σ	0..1	dateTime	Date request signed
requester	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization \| Patient \| RelatedPerson \| Device)	Who/what is requesting service
Documentation for this format

This structure is derived from ServiceRequest

Summary

Mandatory: 1 element
Must-Support: 5 elements

Differential View

This structure is derived from ServiceRequest

Name	Flags	Card.	Type	Description & Constraints
ServiceRequest	S	0..*	ServiceRequest	eICR ServiceRequest
identifier	S	0..*	Identifier	Identifiers assigned to this order
code	S	1..1	CodeableConcept	What is being requested/ordered Binding: LOINCDiagnosticReportCodes (extensible): LOINC Diagnostic Report Codes
subject		1..1	Reference(Patient)	Individual or Entity the service is ordered for
occurrence[x]	S	0..1	dateTime, Period, Timing	When service should occur
authoredOn	S	0..1	dateTime	Date request signed
requester	S	0..1	Reference(Practitioner \| PractitionerRole \| Organization \| Patient \| RelatedPerson \| Device)	Who/what is requesting service
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ServiceRequest	SI	0..*	ServiceRequest	eICR ServiceRequest
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Identifiers assigned to this order
instantiatesCanonical	Σ	0..*	canonical(ActivityDefinition \| PlanDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn	Σ	0..*	Reference(CarePlan \| ServiceRequest \| MedicationRequest)	What request fulfills
replaces	Σ	0..*	Reference(ServiceRequest)	What request replaces
requisition	Σ	0..1	Identifier	Composite Request ID
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown Binding: RequestStatus (required): The status of a service order.
intent	?!Σ	1..1	code	proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option Binding: RequestIntent (required): The kind of service request.
category	Σ	0..*	CodeableConcept	Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
priority	Σ	0..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
doNotPerform	?!Σ	0..1	boolean	True if service/procedure should not be performed
code	SΣ	1..1	CodeableConcept	What is being requested/ordered Binding: LOINCDiagnosticReportCodes (extensible): LOINC Diagnostic Report Codes
orderDetail	ΣI	0..*	CodeableConcept	Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
quantity[x]	Σ	0..1		Service amount
quantityQuantity			Quantity
quantityRatio			Ratio
quantityRange			Range
subject	Σ	1..1	Reference(Patient)	Individual or Entity the service is ordered for
encounter	Σ	0..1	Reference(Encounter)	Encounter in which the request was created
occurrence[x]	SΣ	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Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization \| Patient \| RelatedPerson \| Device)	Who/what is requesting service
performerType	Σ	0..1	CodeableConcept	Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
performer	Σ	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| HealthcareService \| Patient \| Device \| RelatedPerson)	Requested performer
locationCode	Σ	0..*	CodeableConcept	Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
locationReference	Σ	0..*	Reference(Location)	Requested location
reasonCode	Σ	0..*	CodeableConcept	Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
reasonReference	Σ	0..*	Reference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Explanation/Justification for service or service
insurance		0..*	Reference(Coverage \| ClaimResponse)	Associated insurance coverage
supportingInfo		0..*	Reference(Resource)	Additional clinical information
specimen	Σ	0..*	Reference(Specimen)	Procedure Samples
bodySite	Σ	0..*	CodeableConcept	Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
note		0..*	Annotation	Comments
patientInstruction	Σ	0..1	string	Patient or consumer-oriented instructions
relevantHistory		0..*	Reference(Provenance)	Request provenance
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
ServiceRequest.language	preferred	CommonLanguages Max Binding: AllLanguages
ServiceRequest.status	required	RequestStatus
ServiceRequest.intent	required	RequestIntent
ServiceRequest.category	example	ServiceRequestCategoryCodes
ServiceRequest.priority	required	RequestPriority
ServiceRequest.code	extensible	LOINCDiagnosticReportCodes
ServiceRequest.orderDetail	example	ServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]	example	SNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerType	example	ParticipantRoles
ServiceRequest.locationCode	example	ServiceDeliveryLocationRoleType
ServiceRequest.reasonCode	example	ProcedureReasonCodes
ServiceRequest.bodySite	example	SNOMEDCTBodyStructures

Constraints

Id	Grade	Path	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()
prr-1	error	ServiceRequest	orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists()
ele-1	error	ServiceRequest.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ServiceRequest.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	ServiceRequest.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ServiceRequest.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	ServiceRequest.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.instantiatesCanonical	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.instantiatesUri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.replaces	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.requisition	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.intent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.priority	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.doNotPerform	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.orderDetail	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.quantity[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.encounter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.occurrence[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.asNeeded[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.authoredOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.requester	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.performerType	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.locationCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.locationReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.reasonCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.reasonReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.insurance	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.supportingInfo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.specimen	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.bodySite	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.patientInstruction	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	ServiceRequest.relevantHistory	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2020+ HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). Package hl7.fhir.us.ecr#2.0.0 based on FHIR 4.0.1. Generated 2022-01-18
Links: Table of Contents | QA Report | Version History | Search | | Propose a change