CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG - Local Development build (v3.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: AcuteCareHospitalMonthlyReportingServiceRequest - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the ach-monthly-servicerequest resource profile.

See the documentation on how to interpret the contents of this table

0. ServiceRequest
Definition

-


A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Short A request for a service to be performed
Comments

-

Control 0..*
Is Modifier false
Must Support false
Summary false
Alternate Names diagnostic request, referral, referral request, transfer of care request
Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
prr-1: orderDetail SHALL only be present if code is present (orderDetail.empty() or code.exists())
prr-1: orderDetail SHALL only be present if code is present (orderDetail.empty() or code.exists())
2. ServiceRequest.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short (NHSN-MS) Logical id of this artifactLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control 10..1
Type id
Is Modifier false
Must Support true
Summary true
4. ServiceRequest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short A set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control 0..1
Type uri
Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ServiceRequest.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short ExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on ServiceRequest.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. ServiceRequest.extension:reasonRefused
Slice Name reasonRefused
Definition

Indicates the reason the event was not performed.

Short (NHSN-MS) Extension
Control 0..1
This element is affected by the following invariants: ele-1
Type Extension(QICore Do Not Perform Reason) (Extension Type: CodeableConcept)
Is Modifier false
Must Support true
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. ServiceRequest.extension:reasonRefused.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short ExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..0*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on ServiceRequest.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. ServiceRequest.extension:reasonRefused.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Short (NHSN-MS) Extension urlidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control 1..1
Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
XML Format In the XML format, this property is represented as an attribute.
Summary false
Fixed Value
{
  "url" : "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason"
}
<url value="http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason"/>
14. ServiceRequest.extension:reasonRefused.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short (NHSN-MS) ExtensionValue of extension
Control 0..1
Binding Unless not suitable, these codes SHALL be taken from For codes, see QICore Negation Reason Codes
(extensible to http://hl7.org/fhir/us/qicore/ValueSet/qicore-negation-reason)

The reason the event did not occur or was not performed

Type CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier false
Must Support true
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. ServiceRequest.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary false
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. ServiceRequest.status
Definition

The status of the order.

Short (NHSN-MS)(QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknowndraft | active | on-hold | revoked | completed | entered-in-error | unknown
Comments

The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource.


The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource.

Control 1..1
Binding The codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/request-status|4.0.1)

The status of a service order.

Type code
Is Modifier true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. ServiceRequest.intent
Definition

Whether the request is a proposal, plan, an original order or a reflex order.

Short (NHSN-MS)(USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | optionproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Comments

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Control 1..1
Binding The codes SHALL be taken from RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1
(required to http://hl7.org/fhir/ValueSet/request-intent|4.0.1)

The kind of service request.

Type code
Is Modifier true because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. ServiceRequest.category
Definition

A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").

Short (NHSN-MS)(QI-Core)(USCDI) Classification of service or procedureClassification of service
Comments

There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.

Control 0..*
Binding The codes SHALL be taken from For example codes, see Service Request Category ValueSethttp://hl7.org/fhir/ValueSet/servicerequest-category|4.0.1
(required to http://www.cdc.gov/nhsn/fhirportal/dqm/ig/ValueSet/service-request-category-valueset)
Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Requirements

Used for filtering what service request are retrieved and displayed.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing This element introduces a set of slices on ServiceRequest.category. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

24. ServiceRequest.category:us-core
Slice Name us-core
Definition

A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").

Short (NHSN-MS)(USCDI) Classification of serviceClassification of service
Comments

There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.

Control 0..*
Binding The codes SHALL be taken from For example codes, see US Core ServiceRequest Category Codeshttp://hl7.org/fhir/ValueSet/servicerequest-category|4.0.1
(required to http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category)

Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


Classification of the requested service.

Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Requirements

Used for filtering what service request are retrieved and displayed.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. ServiceRequest.priority
Definition

Indicates how quickly the ServiceRequest should be addressed with respect to other requests.

Short (NHSN-MS) routine | urgent | asap | statroutine | urgent | asap | stat
Control 0..1
Binding The codes SHALL be taken from RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Type code
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Meaning if Missing If missing, this task should be performed with normal priority
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. ServiceRequest.doNotPerform
Definition

Set this to true if the record is saying that the service/procedure should NOT be performed.

Short (NHSN-MS)(QI-Core) True if service/procedure should not be performedTrue if service/procedure should not be performed
Comments

In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.

Control 0..1
Type boolean
Is Modifier true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Requirements

Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc.

Meaning if Missing If missing, the request is a positive request e.g. "do perform"
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ServiceRequest.code
Definition

A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.

Short (NHSN-MS)(USCDI) What is being requested/orderedWhat is being requested/ordered
Comments

Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.

Control 10..1
Binding Unless not suitable, these codes SHALL be taken from For example codes, see USCoreProcedureCodes (6.1.0)http://hl7.org/fhir/ValueSet/procedure-code|4.0.1
(extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|6.1.0)
Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Alternate Names service requested
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
not-done-extension-present: qicore-notDoneValueSet extension does not exist (extension.where(url='http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists().not())
32. ServiceRequest.code.extension:notDoneValueSet
Slice Name notDoneValueSet
Definition

A logical reference (e.g. a reference to ValueSet.url) to a value set/version that identifies a set of possible coded values representing activities that were not requested, ordered, or performed.

Short (QI-Core) What was not requested
Control 0..1
Type Extension(QICore Not Done ValueSet) (Extension Type: canonical(ValueSet))
Is Modifier false
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. ServiceRequest.subject
Definition

On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).

Short (NHSN-MS)(QI-Core)(USCDI) Individual or Entity the service is ordered forIndividual or Entity the service is ordered for
Control 1..1
Type Reference(Cross-Measure Patient Profile, Patient, Group, Location, Device)bundled
Is Modifier false
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. ServiceRequest.subject.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short (NHSN-MS) Literal reference, Relative, internal or absolute URLLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. ServiceRequest.encounter
Definition

An encounter that provides additional information about the healthcare context in which this request is made.

Short (NHSN-MS) Encounter in which the request was createdEncounter in which the request was created
Control 0..1
Type Reference(Encounter, Encounter)bundled
Is Modifier false
Must Support true
Summary true
Alternate Names context
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. ServiceRequest.encounter.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short (NHSN-MS) Literal reference, Relative, internal or absolute URLLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. ServiceRequest.occurrence[x]
Definition

The date/time at which the requested service should occur.

Short (NHSN-MS)(QI-Core)(USCDI) When service should occurWhen service should occur
Control 0..1
Type Choice of: Period, dateTime, Timing
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Must Support Types PerioddateTime
Summary true
Alternate Names schedule
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. ServiceRequest.asNeeded[x]
Definition

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

Short (NHSN-MS) Preconditions for servicePreconditions for service
Control 0..1
Binding For example codes, see SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1
(example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason)

A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

Type Choice of: boolean, CodeableConcept
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. ServiceRequest.authoredOn
Definition

When the request transitioned to being actionable.

Short (NHSN-MS)(QI-Core)(USCDI) Date request signedDate request signed
Control 10..1
Type dateTime
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Alternate Names orderedOn
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. ServiceRequest.requester
Definition

The individual who initiated the request and has responsibility for its activation.

Short (USCDI) Who/what is requesting serviceWho/what is requesting service
Comments

This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.

Control 0..1
Type Reference(US Core Practitioner Profile, US Core Organization Profile, US Core Patient Profile, PractitionerRole, US Core RelatedPerson Profile, Device, Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
Is Modifier false
Must Support true
Must Support Types Reference(US Core Practitioner Profile)
Summary true
Alternate Names author, orderer
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. ServiceRequest.reasonCode
Definition

An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInfo.

Short (QI-Core)(USCDI) Explanation/Justification for procedure or serviceExplanation/Justification for procedure or service
Comments

This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use CodeableConcept.text element if the data is free (uncoded) text as shown in the CT Scan example.


This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use CodeableConcept.text element if the data is free (uncoded) text as shown in the CT Scan example.

Control 0..*
Binding Unless not suitable, these codes SHALL be taken from For example codes, see USCoreConditionCodes (6.1.0)http://hl7.org/fhir/ValueSet/procedure-reason|4.0.1
(extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code|6.1.0)
Type CodeableConcept
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. ServiceRequest.reasonReference
Definition

Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in supportingInfo.

Short (NHSN-MS)(QI-Core)(USCDI) Explanation/Justification for service or serviceExplanation/Justification for service or service
Comments

This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in DiagnosticReport.conclusion and/or DiagnosticReport.conclusionCode. When using a reference to DocumentReference, the target document should contain clear findings language providing the relevant reason for this service request. Use the CodeableConcept text element in ServiceRequest.reasonCode if the data is free (uncoded) text as shown in the CT Scan example.


This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in DiagnosticReport.conclusion and/or DiagnosticReport.conclusionCode. When using a reference to DocumentReference, the target document should contain clear findings language providing the relevant reason for this service request. Use the CodeableConcept text element in ServiceRequest.reasonCode if the data is free (uncoded) text as shown in the CT Scan example.

Control 0..*
Type Reference(Condition, Observation, DiagnosticReport, DocumentReference, Condition, Observation, DiagnosticReport, DocumentReference)
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. ServiceRequest.specimen
Definition

One or more specimens that the laboratory procedure will use.

Short (NHSN-MS) Procedure SamplesProcedure Samples
Comments

Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the Specimen resource points to the ServiceRequest.


Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the Specimen resource points to the ServiceRequest.

Control 0..*
Type Reference(ACH Monthly Event Specimen, Specimen)bundled
Is Modifier false
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. ServiceRequest.specimen.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short (NHSN-MS) Literal reference, Relative, internal or absolute URLLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. ServiceRequest
2. ServiceRequest.id
Short (NHSN-MS) Logical id of this artifact
Control 1..?
Must Support true
4. ServiceRequest.meta
6. ServiceRequest.meta.extension:link-received-date-extension
Slice Name link-received-date-extension
Control 0..1
Type Extension(Received Date) (Extension Type: dateTime)
8. ServiceRequest.extension
Slicing This element introduces a set of slices on ServiceRequest.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. ServiceRequest.extension:reasonRefused
Slice Name reasonRefused
Short (NHSN-MS) Extension
Control 0..1
Type Extension(QICore Do Not Perform Reason) (Extension Type: CodeableConcept)
Must Support true
12. ServiceRequest.extension:reasonRefused.extension
Control 0..0
14. ServiceRequest.extension:reasonRefused.url
Short (NHSN-MS) Extension url
Must Support true
16. ServiceRequest.extension:reasonRefused.value[x]
Short (NHSN-MS) Extension
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Must Support true
18. ServiceRequest.status
Short (NHSN-MS)(QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown
20. ServiceRequest.intent
Short (NHSN-MS)(USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
22. ServiceRequest.category
Short (NHSN-MS)(QI-Core)(USCDI) Classification of service or procedure
Binding The codes SHALL be taken from Service Request Category ValueSet
(required to http://www.cdc.gov/nhsn/fhirportal/dqm/ig/ValueSet/service-request-category-valueset)
24. ServiceRequest.category:us-core
Slice Name us-core
Short (NHSN-MS)(USCDI) Classification of service
26. ServiceRequest.priority
Short (NHSN-MS) routine | urgent | asap | stat
Must Support true
28. ServiceRequest.doNotPerform
Short (NHSN-MS)(QI-Core) True if service/procedure should not be performed
Must Support true
30. ServiceRequest.code
Short (NHSN-MS)(USCDI) What is being requested/ordered
Invariants not-done-extension-present: qicore-notDoneValueSet extension does not exist (extension.where(url='http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists().not())
32. ServiceRequest.code.extension:notDoneValueSet
Slice Name notDoneValueSet
Short (QI-Core) What was not requested
Control 0..1
Type Extension(QICore Not Done ValueSet) (Extension Type: canonical(ValueSet))
34. ServiceRequest.subject
Short (NHSN-MS)(QI-Core)(USCDI) Individual or Entity the service is ordered for
Type Reference(Cross-Measure Patient Profile)bundled
36. ServiceRequest.subject.reference
Short (NHSN-MS) Literal reference, Relative, internal or absolute URL
Control 1..?
Must Support true
38. ServiceRequest.encounter
Short (NHSN-MS) Encounter in which the request was created
Type Reference(Encounter)bundled
Must Support true
40. ServiceRequest.encounter.reference
Short (NHSN-MS) Literal reference, Relative, internal or absolute URL
Control 1..?
Must Support true
42. ServiceRequest.occurrence[x]
Short (NHSN-MS)(QI-Core)(USCDI) When service should occur
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
44. ServiceRequest.asNeeded[x]
Short (NHSN-MS) Preconditions for service
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Must Support true
46. ServiceRequest.authoredOn
Short (NHSN-MS)(QI-Core)(USCDI) Date request signed
Control 1..?
48. ServiceRequest.reasonCode
Short (QI-Core)(USCDI) Explanation/Justification for procedure or service
50. ServiceRequest.reasonReference
Short (NHSN-MS)(QI-Core)(USCDI) Explanation/Justification for service or service
Must Support true
52. ServiceRequest.specimen
Short (NHSN-MS) Procedure Samples
Type Reference(ACH Monthly Event Specimen)bundled
Must Support true
54. ServiceRequest.specimen.reference
Short (NHSN-MS) Literal reference, Relative, internal or absolute URL
Control 1..?
Must Support true

See the documentation on how to interpret the contents of this table

0. ServiceRequest
Definition

-

Short A request for a service to be performed
Comments

-

Control 0..*
Is Modifier false
Must Support false
Summary false
Alternate Names diagnostic request, referral, referral request, transfer of care request
Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
prr-1: orderDetail SHALL only be present if code is present (orderDetail.empty() or code.exists())
2. ServiceRequest.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short (NHSN-MS) Logical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control 1..1
Type id
Is Modifier false
Must Support true
Summary true
4. ServiceRequest.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Metadata about the resource
Control 0..1
Type Meta
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ServiceRequest.meta.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
8. ServiceRequest.meta.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on ServiceRequest.meta.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. ServiceRequest.meta.extension:link-received-date-extension
Slice Name link-received-date-extension
Definition

This extension stores the date and time a Resource was received by the processing system (e.g., NHSNLink).

Short Received Date
Control 0..1
Type Extension(Received Date) (Extension Type: dateTime)
Is Modifier false
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. ServiceRequest.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Short Version specific identifier
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Control 0..1
Type id
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. ServiceRequest.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Short When the resource version last changed
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control 0..1
Type instant
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. ServiceRequest.meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Short Identifies where the resource comes from
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Control 0..1
Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. ServiceRequest.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Short Profiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control 0..*
Type canonical(StructureDefinition)
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. ServiceRequest.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Short Security Labels applied to this resource
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Control 0..*
Binding Unless not suitable, these codes SHALL be taken from All Security Labels
(extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

Security Labels from the Healthcare Privacy and Security Classification System.

Type Coding
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. ServiceRequest.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Short Tags applied to this resource
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Control 0..*
Binding For example codes, see CommonTags
(example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

Type Coding
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. ServiceRequest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short A set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control 0..1
Type uri
Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. ServiceRequest.language
Definition

The base language in which the resource is written.

Short Language of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control 0..1
Binding The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional Bindings Purpose
AllLanguages Max Binding
Type code
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. ServiceRequest.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short Text summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control 0..1
Type Narrative
Is Modifier false
Summary false
Alternate Names narrative, html, xhtml, display
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ServiceRequest.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Short Contained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control 0..*
Type Resource
Is Modifier false
Summary false
Alternate Names inline resources, anonymous resources, contained resources
32. ServiceRequest.extension
Definition

An Extension

Short Extension
Control 0..*
Type Extension
Is Modifier false
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on ServiceRequest.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
34. ServiceRequest.extension:reasonRefused
Slice Name reasonRefused
Definition

Indicates the reason the event was not performed.

Short (NHSN-MS) Extension
Control 0..1
This element is affected by the following invariants: ele-1
Type Extension(QICore Do Not Perform Reason) (Extension Type: CodeableConcept)
Is Modifier false
Must Support true
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. ServiceRequest.extension:reasonRefused.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
38. ServiceRequest.extension:reasonRefused.extension
Definition

An Extension

Short Extension
Control 0..0
Type Extension
Is Modifier false
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on ServiceRequest.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. ServiceRequest.extension:reasonRefused.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Short (NHSN-MS) Extension url
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control 1..1
Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
XML Format In the XML format, this property is represented as an attribute.
Summary false
Fixed Value
{
  "url" : "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason"
}
<url value="http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-doNotPerformReason"/>
42. ServiceRequest.extension:reasonRefused.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short (NHSN-MS) Extension
Control 0..1
Binding Unless not suitable, these codes SHALL be taken from QICore Negation Reason Codes
(extensible to http://hl7.org/fhir/us/qicore/ValueSet/qicore-negation-reason)

The reason the event did not occur or was not performed

Type CodeableConcept
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier false
Must Support true
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. ServiceRequest.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary false
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. ServiceRequest.identifier
Definition

Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

Short Identifiers assigned to this order
Comments

The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.

Note This is a business identifier, not a resource identifier (see discussion)
Control 0..*
Type Identifier
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. ServiceRequest.instantiatesCanonical
Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.

Short Instantiates FHIR protocol or definition
Comments

Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Control 0..*
Type canonical(ActivityDefinition, PlanDefinition)
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. ServiceRequest.instantiatesUri
Definition

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.

Short Instantiates external protocol or definition
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Control 0..*
Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. ServiceRequest.basedOn
Definition

Plan/proposal/order fulfilled by this request.

Short What request fulfills
Control 0..*
Type Reference(CarePlan, ServiceRequest, MedicationRequest)
Is Modifier false
Summary true
Alternate Names fulfills
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. ServiceRequest.replaces
Definition

The request takes the place of the referenced completed or terminated request(s).

Short What request replaces
Control 0..*
Type Reference(ServiceRequest)
Is Modifier false
Summary true
Alternate Names supersedes, prior, renewed order
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. ServiceRequest.requisition
Definition

A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.

Short Composite Request ID
Comments

Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

Control 0..1
Type Identifier
Is Modifier false
Summary true
Requirements

Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes.

Alternate Names grouperId, groupIdentifier
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. ServiceRequest.status
Definition

The status of the order.

Short (NHSN-MS)(QI-Core)(USCDI) draft | active | on-hold | revoked | completed | entered-in-error | unknown
Comments

The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource.

Control 1..1
Binding The codes SHALL be taken from RequestStatus
(required to http://hl7.org/fhir/ValueSet/request-status|4.0.1)

The status of a service order.

Type code
Is Modifier true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. ServiceRequest.intent
Definition

Whether the request is a proposal, plan, an original order or a reflex order.

Short (NHSN-MS)(USCDI) proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Comments

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Control 1..1
Binding The codes SHALL be taken from RequestIntent
(required to http://hl7.org/fhir/ValueSet/request-intent|4.0.1)

The kind of service request.

Type code
Is Modifier true because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. ServiceRequest.category
Definition

A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").

Short (NHSN-MS)(QI-Core)(USCDI) Classification of service or procedure
Comments

There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.

Control 0..*
Binding The codes SHALL be taken from Service Request Category ValueSet
(required to http://www.cdc.gov/nhsn/fhirportal/dqm/ig/ValueSet/service-request-category-valueset)
Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Requirements

Used for filtering what service request are retrieved and displayed.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing This element introduces a set of slices on ServiceRequest.category. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

64. ServiceRequest.category:us-core
Slice Name us-core
Definition

A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").

Short (NHSN-MS)(USCDI) Classification of service
Comments

There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.

Control 0..*
Binding The codes SHALL be taken from US Core ServiceRequest Category Codes
(required to http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category)

Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Requirements

Used for filtering what service request are retrieved and displayed.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. ServiceRequest.priority
Definition

Indicates how quickly the ServiceRequest should be addressed with respect to other requests.

Short (NHSN-MS) routine | urgent | asap | stat
Control 0..1
Binding The codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Type code
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Meaning if Missing If missing, this task should be performed with normal priority
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. ServiceRequest.doNotPerform
Definition

Set this to true if the record is saying that the service/procedure should NOT be performed.

Short (NHSN-MS)(QI-Core) True if service/procedure should not be performed
Comments

In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.

Control 0..1
Type boolean
Is Modifier true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Requirements

Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc.

Meaning if Missing If missing, the request is a positive request e.g. "do perform"
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. ServiceRequest.code
Definition

A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.

Short (NHSN-MS)(USCDI) What is being requested/ordered
Comments

Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.

Control 1..1
Binding Unless not suitable, these codes SHALL be taken from USCoreProcedureCodes (6.1.0)
(extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|6.1.0)
Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Alternate Names service requested
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
not-done-extension-present: qicore-notDoneValueSet extension does not exist (extension.where(url='http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists().not())
72. ServiceRequest.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
74. ServiceRequest.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on ServiceRequest.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
76. ServiceRequest.code.extension:notDoneValueSet
Slice Name notDoneValueSet
Definition

A logical reference (e.g. a reference to ValueSet.url) to a value set/version that identifies a set of possible coded values representing activities that were not requested, ordered, or performed.

Short (QI-Core) What was not requested
Control 0..1
Type Extension(QICore Not Done ValueSet) (Extension Type: canonical(ValueSet))
Is Modifier false
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
78. ServiceRequest.code.coding
Definition

A reference to a code defined by a terminology system.

Short Code defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control 0..*
Type Coding
Is Modifier false
Summary true
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. ServiceRequest.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Short Plain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. ServiceRequest.orderDetail
Definition

Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.

Short Additional order information
Comments

For information from the medical record intended to support the delivery of the requested services, use the supportingInformation element.

Control 0..*
This element is affected by the following invariants: prr-1
Binding For example codes, see ServiceRequestOrderDetailsCodes
(example to http://hl7.org/fhir/ValueSet/servicerequest-orderdetail)

Codified order entry details which are based on order context.

Type CodeableConcept
Is Modifier false
Summary true
Alternate Names detailed instructions
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. ServiceRequest.quantity[x]
Definition

An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).

Short Service amount
Control 0..1
Type Choice of: Quantity, Ratio, Range
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier false
Summary true
Requirements

When ordering a service the number of service items may need to be specified separately from the the service item.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. ServiceRequest.subject
Definition

On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).

Short (NHSN-MS)(QI-Core)(USCDI) Individual or Entity the service is ordered for
Control 1..1
Type Reference(Cross-Measure Patient Profile)bundled
Is Modifier false
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. ServiceRequest.subject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
90. ServiceRequest.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on ServiceRequest.subject.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
92. ServiceRequest.subject.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short (NHSN-MS) Literal reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 1..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. ServiceRequest.subject.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Short Type the reference refers to (e.g. "Patient")
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control 0..1
Binding Unless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. ServiceRequest.subject.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Short Logical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Note This is a business identifier, not a resource identifier (see discussion)
Control 0..1
Type Identifier
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. ServiceRequest.subject.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. ServiceRequest.encounter
Definition

An encounter that provides additional information about the healthcare context in which this request is made.

Short (NHSN-MS) Encounter in which the request was created
Control 0..1
Type Reference(Encounter)bundled
Is Modifier false
Must Support true
Summary true
Alternate Names context
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. ServiceRequest.encounter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
104. ServiceRequest.encounter.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on ServiceRequest.encounter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
106. ServiceRequest.encounter.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short (NHSN-MS) Literal reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 1..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. ServiceRequest.encounter.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Short Type the reference refers to (e.g. "Patient")
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control 0..1
Binding Unless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. ServiceRequest.encounter.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Short Logical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Note This is a business identifier, not a resource identifier (see discussion)
Control 0..1
Type Identifier
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. ServiceRequest.encounter.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. ServiceRequest.occurrence[x]
Definition

The date/time at which the requested service should occur.

Short (NHSN-MS)(QI-Core)(USCDI) When service should occur
Control 0..1
Type Choice of: Period, dateTime, Timing
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Must Support Types Period
Summary true
Alternate Names schedule
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. ServiceRequest.asNeeded[x]
Definition

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

Short (NHSN-MS) Preconditions for service
Control 0..1
Binding For example codes, see SNOMEDCTMedicationAsNeededReasonCodes
(example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason)

A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

Type Choice of: boolean, CodeableConcept
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. ServiceRequest.authoredOn
Definition

When the request transitioned to being actionable.

Short (NHSN-MS)(QI-Core)(USCDI) Date request signed
Control 1..1
Type dateTime
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Alternate Names orderedOn
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. ServiceRequest.requester
Definition

The individual who initiated the request and has responsibility for its activation.

Short (USCDI) Who/what is requesting service
Comments

This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.

Control 0..1
Type Reference(US Core Practitioner Profile, US Core Organization Profile, US Core Patient Profile, PractitionerRole, US Core RelatedPerson Profile, Device)
Is Modifier false
Must Support true
Must Support Types Reference(US Core Practitioner Profile)
Summary true
Alternate Names author, orderer
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. ServiceRequest.performerType
Definition

Desired type of performer for doing the requested service.

Short Performer role
Comments

This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”.

Control 0..1
Binding For example codes, see ParticipantRoles
(example to http://hl7.org/fhir/ValueSet/participant-role)

Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.

Type CodeableConcept
Is Modifier false
Summary true
Alternate Names specialty
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. ServiceRequest.performer
Definition

The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.

Short Requested performer
Comments

If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B).

Control 0..*
Type Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson)
Is Modifier false
Summary true
Alternate Names request recipient
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. ServiceRequest.locationCode
Definition

The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.

Short Requested location
Control 0..*
Binding For example codes, see ServiceDeliveryLocationRoleType (3.0.0)
(example to http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType|3.0.0)

A location type where services are delivered.

Type CodeableConcept
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. ServiceRequest.locationReference
Definition

A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.

Short Requested location
Control 0..*
Type Reference(Location)
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. ServiceRequest.reasonCode
Definition

An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInfo.

Short (QI-Core)(USCDI) Explanation/Justification for procedure or service
Comments

This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use CodeableConcept.text element if the data is free (uncoded) text as shown in the CT Scan example.

Control 0..*
Binding Unless not suitable, these codes SHALL be taken from USCoreConditionCodes (6.1.0)
(extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code|6.1.0)
Type CodeableConcept
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. ServiceRequest.reasonReference
Definition

Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in supportingInfo.

Short (NHSN-MS)(QI-Core)(USCDI) Explanation/Justification for service or service
Comments

This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in DiagnosticReport.conclusion and/or DiagnosticReport.conclusionCode. When using a reference to DocumentReference, the target document should contain clear findings language providing the relevant reason for this service request. Use the CodeableConcept text element in ServiceRequest.reasonCode if the data is free (uncoded) text as shown in the CT Scan example.

Control 0..*
Type Reference(Condition, Observation, DiagnosticReport, DocumentReference)
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. ServiceRequest.insurance
Definition

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.

Short Associated insurance coverage
Control 0..*
Type Reference(Coverage, ClaimResponse)
Is Modifier false
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. ServiceRequest.supportingInfo
Definition

Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.

Short Additional clinical information
Comments

To represent information about how the services are to be delivered use the instructions element.

Control 0..*
Type Reference(Resource)
Is Modifier false
Summary false
Alternate Names Ask at order entry question, AOE
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. ServiceRequest.specimen
Definition

One or more specimens that the laboratory procedure will use.

Short (NHSN-MS) Procedure Samples
Comments

Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the Specimen resource points to the ServiceRequest.

Control 0..*
Type Reference(ACH Monthly Event Specimen)bundled
Is Modifier false
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. ServiceRequest.specimen.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
142. ServiceRequest.specimen.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing This element introduces a set of slices on ServiceRequest.specimen.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
144. ServiceRequest.specimen.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short (NHSN-MS) Literal reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 1..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. ServiceRequest.specimen.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Short Type the reference refers to (e.g. "Patient")
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control 0..1
Binding Unless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. ServiceRequest.specimen.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Short Logical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Note This is a business identifier, not a resource identifier (see discussion)
Control 0..1
Type Identifier
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. ServiceRequest.specimen.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. ServiceRequest.bodySite
Definition

Anatomic location where the procedure should be performed. This is the target site.

Short Location on Body
Comments

Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure.

Control 0..*
Binding For example codes, see SNOMEDCTBodyStructures
(example to http://hl7.org/fhir/ValueSet/body-site)

Codes describing anatomical locations. May include laterality.

Type CodeableConcept
Is Modifier false
Summary true
Requirements

Knowing where the procedure is performed is important for tracking if multiple sites are possible.

Alternate Names location
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. ServiceRequest.note
Definition

Any other notes and comments made about the service request. For example, internal billing notes.

Short Comments
Control 0..*
Type Annotation
Is Modifier false
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. ServiceRequest.patientInstruction
Definition

Instructions in terms that are understood by the patient or consumer.

Short Patient or consumer-oriented instructions
Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. ServiceRequest.relevantHistory
Definition

Key events in the history of the request.

Short Request provenance
Comments

This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.

Control 0..*
Type Reference(Provenance)
Is Modifier false
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

National Center for Emerging and Zoonotic Infectious Diseases