Digital Referral Prescription Implementation Guide
1.0.0 - STU

Digital Referral Prescription Implementation Guide - Downloaded Version 1.0.0 See the Directory of published versions

## Resource Profile: BeReferralServiceRequestNursing - Detailed Descriptions

Active as of 2025-10-10

Definitions for the be-referral-servicerequest-nursing resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

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
Control | 0..*
Is Modifier | 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.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()))
4. 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 | 10..*
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 areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. ServiceRequest.extension:feedback
Slice Name | feedback
Definition | Whether the prescriber requests feedback on the processing of the order
Short | Whether prescriber requests feedback
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(BeFeedbackToPrescriber) (Extension Type: boolean)
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())
8. ServiceRequest.extension:validity
Slice Name | validity
Definition | Begin and end date of the validity of the request
Short | Validity period of the prescription
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(BeValidityPeriod) (Extension Type: Period)
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:latest
Slice Name | latest
Definition | Request must be performed before
Short | Request must be executed before
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(BeLatestEndDate) (Extension Type: dateTime)
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())
12. ServiceRequest.extension:performerType
Slice Name | performerType
Definition | An Extension
Short | Discipline of provider. Replaces .performerType because of insufficient cardinality
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(BePerformerType) (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())
14. ServiceRequest.extension:statusReason
Slice Name | statusReason
Definition | Captures the reason for the current state of the resource.
Short | Reason for current status
Comments | This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason for performing the request at all is captured in reasonCode, not here. (Distinct reason codes for different statuses can be enforced using invariants if they are universal bindings).
Control | 0..1
Type | Extension(Request status 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()`) 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())
16. ServiceRequest.extension:statusReason.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()`) 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 areUnordered and Open, and can be differentiated using the following discriminators: value @ url
18. ServiceRequest.extension:statusReason.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/request-statusReason`
20. ServiceRequest.extension:statusReason.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1 This element is affected by the following invariants: ext-1
Binding | For example codes, see For codes, see BeVSPrescriptionStatusReason (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-prescription-status-reason` )
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. ServiceRequest.extension:device
Slice Name | device
Definition | Extension able to hold a reference and a concept (Temporary solution until https://jira.hl7.org/browse/FHIR-44661 is solved and see Zulip: https://chat.fhir.org/#narrow/stream/179280-fhir.2Finfrastructure-wg/topic/Backporting.20CodeableReference )
Short | BeExtCodeableReference
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(BeExtCodeableReference) (Complex Extension)
Is Modifier | false
Must Support | true
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()`)
24. ServiceRequest.extension:device.extension:reference
Slice Name | reference
Definition | An Extension
Short | ExtensionAdditional content defined by implementations
Control | 0..1*
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())
26. ServiceRequest.extension:device.extension:reference.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.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
28. ServiceRequest.extension:device.extension:reference.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `reference`
30. ServiceRequest.extension:device.extension:concept
Slice Name | concept
Definition | An Extension
Short | ExtensionAdditional content defined by implementations
Control | 0..1*
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())
32. ServiceRequest.extension:device.extension:concept.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.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
34. ServiceRequest.extension:device.extension:concept.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `concept`
36. ServiceRequest.extension:device.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference`
38. ServiceRequest.extension:device.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..01
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
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()))
40. 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())
42. 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
Must Support | true
Summary | true
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.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
44. ServiceRequest.identifier:UHMEP
Slice Name | UHMEP
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
Short | Reference ID of the UHMEP once available thereIdentifiers 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..1*
Type | Identifier
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()))
46. ServiceRequest.identifier:UHMEP.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. ServiceRequest.identifier:UHMEP.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. ServiceRequest.identifier:UHMEP.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. ServiceRequest.identifier:SHORT
Slice Name | SHORT
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
Short | Patient friendly ID (UHMEP 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..1*
Type | Identifier
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())) be-inv-uhmep-short: The format of UHMEP-SHORT is 6 capital alphanumerics, without O (`Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()`)
54. ServiceRequest.identifier:SHORT.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. ServiceRequest.identifier:SHORT.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. ServiceRequest.identifier:SHORT.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. ServiceRequest.basedOn
Definition | Plan/proposal/order fulfilled by this request.
Short | What request fulfills
Control | 0..*
Type | Reference(ServiceRequest, MedicationRequest, CarePlan, ServiceRequest, MedicationRequest)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | true
Alternate Names | fulfills
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. ServiceRequest.status
Definition | The status of the order.
Short | 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. 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 http://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()))
64. ServiceRequest.intent
Definition | Whether the request is a proposal, plan, an original order or a reflex order.
Short | 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 http://hl7.org/fhir/ValueSet/request-intent|4.0.1 (required to `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` ) The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. 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()))
66. ServiceRequest.category
Definition | A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
Short | 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 | 10..1*
Binding | For example codes, see BeReferralCategory http://hl7.org/fhir/ValueSet/servicerequest-category|4.0.1 (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-referral-category` ) The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. 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()))
68. ServiceRequest.doNotPerform
Definition | Set this to true if the record is saying that the service/procedure should NOT be performed.
Short | 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
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 | 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 | 10..1
Binding | For example codes, see BeVSRequestedServicesNurse http://hl7.org/fhir/ValueSet/procedure-code|4.0.1 (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-requested-services-nurse` ) The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
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()))
72. 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 | Details of the nursing activityAdditional 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 BeVSRequestedServicesNurseDetail http://hl7.org/fhir/ValueSet/servicerequest-orderdetail|4.0.1 (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-requested-services-nurse-detail` ) The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. Codified order entry details which are based on order context.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | detailed instructions
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. 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()))
Slicing | This element introduces a set of slices on `ServiceRequest.quantity[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
76. ServiceRequest.quantity[x]:quantityQuantity
Slice Name | quantityQuantity
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 | 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()))
78. ServiceRequest.quantity[x]:quantityQuantity.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. ServiceRequest.quantity[x]:quantityQuantity.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Control | 0..1
Binding | The codes SHALL be taken from QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. ServiceRequest.quantity[x]:quantityQuantity.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. ServiceRequest.quantity[x]:quantityQuantity.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1
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
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
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 | Individual or Entity the service is ordered for
Control | 1..1
Type | Reference(BePatient, Patient, Group, Location, Device)
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.occurrence[x]
Definition | The date/time at which the requested service should occur.
Short | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.When service should occur
Control | 0..1
Type | Timing, dateTime, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | schedule
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.occurrence[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
90. ServiceRequest.occurrence[x]:occurrenceTiming
Slice Name | occurrenceTiming
Definition | The date/time at which the requested service should occur.
Short | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.When service should occur
Control | 0..1
Type | Timing, dateTime, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | schedule
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. ServiceRequest.occurrence[x]:occurrenceTiming.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 even if unrecognized
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 element that contains them
Summary | true
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, modifiers
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())
94. ServiceRequest.occurrence[x]:occurrenceTiming.repeat
Definition | A set of rules that describe when the event is scheduled.
Short | When the event is to occur
Control | 0..1
Type | Element
Is Modifier | false
Summary | true
Requirements | Many timing schedules are determined by regular repetitions.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) tim-1: if there's a duration, there needs to be duration units (`duration.empty() or durationUnit.exists()`) tim-2: if there's a period, there needs to be period units (`period.empty() or periodUnit.exists()`) tim-4: duration SHALL be a non-negative value (`duration.exists() implies duration >= 0`) tim-5: period SHALL be a non-negative value (`period.exists() implies period >= 0`) tim-6: If there's a periodMax, there must be a period (`periodMax.empty() or period.exists()`) tim-7: If there's a durationMax, there must be a duration (`durationMax.empty() or duration.exists()`) tim-8: If there's a countMax, there must be a count (`countMax.empty() or count.exists()`) tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) (`offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))`) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa (`timeOfDay.empty() or when.empty()`) tim-1: if there's a duration, there needs to be duration units (duration.empty() or durationUnit.exists()) tim-2: if there's a period, there needs to be period units (period.empty() or periodUnit.exists()) tim-4: duration SHALL be a non-negative value (duration.exists() implies duration >= 0) tim-5: period SHALL be a non-negative value (period.exists() implies period >= 0) tim-6: If there's a periodMax, there must be a period (periodMax.empty() or period.exists()) tim-7: If there's a durationMax, there must be a duration (durationMax.empty() or duration.exists()) tim-8: If there's a countMax, there must be a count (countMax.empty() or count.exists()) tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) (offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa (timeOfDay.empty() or when.empty())
96. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.bounds[x]
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
Short | Length/Range of lengths, or (Start and/or end) limits
Control | 0..1
Type | Choice of: Duration, Range, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
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.occurrence[x].repeat.bounds[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
98. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.bounds[x]:boundsDuration
Slice Name | boundsDuration
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
Short | Length/Range of lengths, or (Start and/or end) limits
Control | 0..1
Type | Duration, Period, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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()))
100. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.count
Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
Short | Number of times to repeat
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Repetitions may be limited by end time or total occurrences.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.duration
Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
Short | How long when it happens
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Some activities are not instantaneous and need to be maintained for a period of time.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit
Definition | The units of time for the duration, in UCUM units.
Short | s | min | h | d | wk | mo | a - unit of time (UCUM)
Control | 0..1
Binding | The codes SHALL be taken from UnitsOfTime http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 (required to `http://hl7.org/fhir/ValueSet/units-of-time|4.0.1` ) A unit of time (units from UCUM).
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
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequency
Definition | The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
Short | Event occurs frequency times per period
Control | 0..1
Type | positiveInt
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 no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when
Definition | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
Short | Code for time period of occurrence
Comments | When more than one event is listed, the event is tied to the union of the specified events.
Control | 0..*
Binding | The codes SHALL be taken from EventTiming http://hl7.org/fhir/ValueSet/event-timing|4.0.1 (required to `http://hl7.org/fhir/ValueSet/event-timing|4.0.1` ) Real world event relating to the schedule.
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
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. ServiceRequest.authoredOn
Definition | When the request transitioned to being actionable.
Short | Date 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())) be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) (`empty() or toString().length()=25`)
112. ServiceRequest.requester
Definition | The individual who initiated the request and has responsibility for its activation.
Short | Prescriber of the requested 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 | 10..1
Type | Reference(BePractitionerRole, Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | author, orderer
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. 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..01
Binding | For example codes, see ParticipantRoles http://hl7.org/fhir/ValueSet/participant-role|4.0.1 (example to `http://hl7.org/fhir/ValueSet/participant-role|4.0.1` ) Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | specialty
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. ServiceRequest.performer
Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
Short | Requested performer - typically reference to practitionerroles
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..0*
Type | Reference(BePractitionerRole, Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | request recipient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. 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 | 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. 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..1*
Binding | For example codes, see ProcedureReasonCodes http://hl7.org/fhir/ValueSet/procedure-reason|4.0.1 (example to `http://hl7.org/fhir/ValueSet/procedure-reason|4.0.1` ) Diagnosis or problem codes justifying the reason for requesting the service investigation.
Type | CodeableConcept
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()))
120. 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
Must Support | true
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()))
122. 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 http://hl7.org/fhir/ValueSet/body-site|4.0.1 (example to `http://hl7.org/fhir/ValueSet/body-site|4.0.1` ) Codes describing anatomical locations. May include laterality.
Type | CodeableConcept
Is Modifier | false
Must Support | true
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()))
124. ServiceRequest.bodySite.extension:bodyLaterality
Slice Name | bodyLaterality
Definition | An explicit statement of laterality of a lesion, or a treatment, etc.
Short | BeExtLaterality
Control | 0..1
Type | Extension(BeExtLaterality) (Extension Type: Coding)
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())
126. ServiceRequest.note
Definition | Any other notes and comments made about the service request. For example, internal billing notes.
Short | Comments
Control | 0..*
Type | Annotation(BeCodedAnnotation)
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()))
128. ServiceRequest.note.extension:code
Slice Name | code
Definition | Codifies the content of an Element
Short | Code
Control | 0..1
Type | Extension(BeExtCodeableConcept) (Extension Type: CodeableConcept)
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())
130. ServiceRequest.note.extension:code.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.note.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
132. ServiceRequest.note.extension:code.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept`
134. ServiceRequest.note.text
Definition | The text of the annotation in markdown format.
Short | The annotation - plain text without markdown is strongly recommendedThe annotation - text content (as markdown)
Control | 1..1
Type | markdown
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()))

Guidance on how to interpret the contents of this table can be foundhere

0. ServiceRequest
2. ServiceRequest.basedOn
Type | Reference(ServiceRequest, MedicationRequest)
4. ServiceRequest.category
6. ServiceRequest.category.coding
8. ServiceRequest.category.coding.system
Fixed Value | `http://snomed.info/sct`
10. ServiceRequest.category.coding.code
Fixed Value | `9632001`
12. ServiceRequest.code
Binding | For example codes, see BeVSRequestedServicesNurse (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-requested-services-nurse` ) The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
14. ServiceRequest.orderDetail
Short | Details of the nursing activity
Binding | For example codes, see BeVSRequestedServicesNurseDetail (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-requested-services-nurse-detail` ) The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
16. ServiceRequest.quantity[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Slicing | This element introduces a set of slices on `ServiceRequest.quantity[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
18. ServiceRequest.quantity[x]:quantityQuantity
Slice Name | quantityQuantity
Control | 0..1
Type | Quantity
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
20. ServiceRequest.quantity[x]:quantityQuantity.value
Must Support | true
22. ServiceRequest.quantity[x]:quantityQuantity.system
Must Support | true
24. ServiceRequest.quantity[x]:quantityQuantity.code
Must Support | true
26. ServiceRequest.occurrence[x]
Type | Timing, dateTime, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Slicing | This element introduces a set of slices on `ServiceRequest.occurrence[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
28. ServiceRequest.occurrence[x]:occurrenceTiming
Slice Name | occurrenceTiming
Control | 0..1
Type | Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
30. ServiceRequest.occurrence[x]:occurrenceTiming.repeat
32. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.bounds[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Slicing | This element introduces a set of slices on `ServiceRequest.occurrence[x].repeat.bounds[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
34. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.bounds[x]:boundsDuration
Slice Name | boundsDuration
Control | 0..1
Type | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Must Support | true
36. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.count
Must Support | true
38. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.duration
Must Support | true
40. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit
Must Support | true
42. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequency
Must Support | true
44. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when
Must Support | true
46. ServiceRequest.reasonCode
Control | 0..1

Guidance on how to interpret the contents of this table can be foundhere

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
Control | 0..*
Is Modifier | 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 | 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 | 0..1
Type | id
Is Modifier | false
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.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())`)
8. 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|4.0.1` ) 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())`)
10. 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())`)
12. 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
14. ServiceRequest.extension
Definition | An Extension
Short | Extension
Control | 1..*
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 areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. ServiceRequest.extension:feedback
Slice Name | feedback
Definition | Whether the prescriber requests feedback on the processing of the order
Short | Whether prescriber requests feedback
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(BeFeedbackToPrescriber) (Extension Type: boolean)
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()`)
18. ServiceRequest.extension:validity
Slice Name | validity
Definition | Begin and end date of the validity of the request
Short | Validity period of the prescription
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(BeValidityPeriod) (Extension Type: Period)
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()`)
20. ServiceRequest.extension:latest
Slice Name | latest
Definition | Request must be performed before
Short | Request must be executed before
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(BeLatestEndDate) (Extension Type: dateTime)
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()`)
22. ServiceRequest.extension:performerType
Slice Name | performerType
Definition | An Extension
Short | Discipline of provider. Replaces .performerType because of insufficient cardinality
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(BePerformerType) (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()`)
24. ServiceRequest.extension:statusReason
Slice Name | statusReason
Definition | Captures the reason for the current state of the resource.
Short | Reason for current status
Comments | This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason for performing the request at all is captured in reasonCode, not here. (Distinct reason codes for different statuses can be enforced using invariants if they are universal bindings).
Control | 0..1
Type | Extension(Request status 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()`)
26. ServiceRequest.extension:statusReason.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 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
28. ServiceRequest.extension:statusReason.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 areUnordered and Open, and can be differentiated using the following discriminators: value @ url
30. ServiceRequest.extension:statusReason.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/request-statusReason`
32. ServiceRequest.extension:statusReason.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1 This element is affected by the following invariants: ext-1
Binding | For example codes, see BeVSPrescriptionStatusReason (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-prescription-status-reason` )
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. ServiceRequest.extension:device
Slice Name | device
Definition | Extension able to hold a reference and a concept (Temporary solution until https://jira.hl7.org/browse/FHIR-44661 is solved and see Zulip: https://chat.fhir.org/#narrow/stream/179280-fhir.2Finfrastructure-wg/topic/Backporting.20CodeableReference )
Short | BeExtCodeableReference
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(BeExtCodeableReference) (Complex Extension)
Is Modifier | false
Must Support | true
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:device.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:device.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.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
40. ServiceRequest.extension:device.extension:reference
Slice Name | reference
Definition | An Extension
Short | Extension
Control | 0..1
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()`)
42. ServiceRequest.extension:device.extension:reference.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
44. ServiceRequest.extension:device.extension:reference.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.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
46. ServiceRequest.extension:device.extension:reference.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `reference`
48. ServiceRequest.extension:device.extension:reference.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Type | Reference(DeviceDefinition)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. ServiceRequest.extension:device.extension:concept
Slice Name | concept
Definition | An Extension
Short | Extension
Control | 0..1
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()`)
52. ServiceRequest.extension:device.extension:concept.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
54. ServiceRequest.extension:device.extension:concept.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.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
56. ServiceRequest.extension:device.extension:concept.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `concept`
58. ServiceRequest.extension:device.extension:concept.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. ServiceRequest.extension:device.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference`
62. ServiceRequest.extension:device.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..0
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
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())`)
64. 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()`)
66. 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
Must Support | true
Summary | true
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.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
68. ServiceRequest.identifier:UHMEP
Slice Name | UHMEP
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
Short | Reference ID of the UHMEP once available there
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..1
Type | Identifier
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())`)
70. ServiceRequest.identifier:UHMEP.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
72. ServiceRequest.identifier:UHMEP.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.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
74. ServiceRequest.identifier:UHMEP.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. ServiceRequest.identifier:UHMEP.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type|4.0.1` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. ServiceRequest.identifier:UHMEP.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. ServiceRequest.identifier:UHMEP.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. ServiceRequest.identifier:UHMEP.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. ServiceRequest.identifier:UHMEP.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. ServiceRequest.identifier:SHORT
Slice Name | SHORT
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
Short | Patient friendly ID (UHMEP SHORT)
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..1
Type | Identifier
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())`) be-inv-uhmep-short: The format of UHMEP-SHORT is 6 capital alphanumerics, without O (`Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()`)
88. ServiceRequest.identifier:SHORT.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.identifier:SHORT.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.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
92. ServiceRequest.identifier:SHORT.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. ServiceRequest.identifier:SHORT.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type|4.0.1` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. ServiceRequest.identifier:SHORT.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. ServiceRequest.identifier:SHORT.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. ServiceRequest.identifier:SHORT.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. ServiceRequest.identifier:SHORT.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. 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())`)
106. 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())`)
108. ServiceRequest.basedOn
Definition | Plan/proposal/order fulfilled by this request.
Short | What request fulfills
Control | 0..*
Type | Reference(ServiceRequest, MedicationRequest)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | true
Alternate Names | fulfills
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. 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())`)
112. 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())`)
114. ServiceRequest.status
Definition | The status of the order.
Short | 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())`)
116. ServiceRequest.intent
Definition | Whether the request is a proposal, plan, an original order or a reflex order.
Short | 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 actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
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())`)
118. ServiceRequest.category
Definition | A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
Short | 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 | 1..1
Binding | For example codes, see BeReferralCategory (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-referral-category` ) The actual valueset will be provided when a terminology package is available. For current guidance, see the included 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())`)
120. ServiceRequest.category.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
122. ServiceRequest.category.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.category.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
124. ServiceRequest.category.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())`)
126. ServiceRequest.category.coding.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
128. ServiceRequest.category.coding.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.category.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
130. ServiceRequest.category.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
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
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://snomed.info/sct`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. ServiceRequest.category.coding.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
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())`)
134. ServiceRequest.category.coding.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Fixed Value | `9632001`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. ServiceRequest.category.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
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 | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. ServiceRequest.category.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. ServiceRequest.category.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())`)
142. ServiceRequest.priority
Definition | Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
Short | 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
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())`)
144. ServiceRequest.doNotPerform
Definition | Set this to true if the record is saying that the service/procedure should NOT be performed.
Short | 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
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())`)
146. ServiceRequest.code
Definition | A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
Short | 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 | For example codes, see BeVSRequestedServicesNurse (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-requested-services-nurse` ) The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
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())`)
148. 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 | Details of the nursing activity
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 BeVSRequestedServicesNurseDetail (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-requested-services-nurse-detail` ) The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | detailed instructions
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. 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())`)
Slicing | This element introduces a set of slices on `ServiceRequest.quantity[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
152. ServiceRequest.quantity[x]:quantityQuantity
Slice Name | quantityQuantity
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 | Quantity
[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())`)
154. ServiceRequest.quantity[x]:quantityQuantity.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
156. ServiceRequest.quantity[x]:quantityQuantity.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.quantity[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
158. ServiceRequest.quantity[x]:quantityQuantity.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
160. ServiceRequest.quantity[x]:quantityQuantity.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > - how to understand the value
Control | 0..1
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
162. ServiceRequest.quantity[x]:quantityQuantity.unit
Definition | A human-readable form of the unit.
Short | Unit representation
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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
164. ServiceRequest.quantity[x]:quantityQuantity.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
166. ServiceRequest.quantity[x]:quantityQuantity.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1
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
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
168. 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 | Individual or Entity the service is ordered for
Control | 1..1
Type | Reference(BePatient)
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())`)
170. ServiceRequest.encounter
Definition | An encounter that provides additional information about the healthcare context in which this request is made.
Short | Encounter in which the request was created
Control | 0..1
Type | Reference(Encounter)
Is Modifier | false
Summary | true
Alternate Names | context
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
172. ServiceRequest.occurrence[x]
Definition | The date/time at which the requested service should occur.
Short | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.
Control | 0..1
Type | Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | schedule
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.occurrence[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
174. ServiceRequest.occurrence[x]:occurrenceTiming
Slice Name | occurrenceTiming
Definition | The date/time at which the requested service should occur.
Short | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.
Control | 0..1
Type | Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | schedule
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
176. ServiceRequest.occurrence[x]:occurrenceTiming.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
178. ServiceRequest.occurrence[x]:occurrenceTiming.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.occurrence[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
180. ServiceRequest.occurrence[x]:occurrenceTiming.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 even if unrecognized
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 element that contains them
Summary | true
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, modifiers
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()`)
182. ServiceRequest.occurrence[x]:occurrenceTiming.event
Definition | Identifies specific times when the event occurs.
Short | When the event occurs
Control | 0..*
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
184. ServiceRequest.occurrence[x]:occurrenceTiming.repeat
Definition | A set of rules that describe when the event is scheduled.
Short | When the event is to occur
Control | 0..1
Type | Element
Is Modifier | false
Summary | true
Requirements | Many timing schedules are determined by regular repetitions.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) tim-1: if there's a duration, there needs to be duration units (`duration.empty() or durationUnit.exists()`) tim-2: if there's a period, there needs to be period units (`period.empty() or periodUnit.exists()`) tim-4: duration SHALL be a non-negative value (`duration.exists() implies duration >= 0`) tim-5: period SHALL be a non-negative value (`period.exists() implies period >= 0`) tim-6: If there's a periodMax, there must be a period (`periodMax.empty() or period.exists()`) tim-7: If there's a durationMax, there must be a duration (`durationMax.empty() or duration.exists()`) tim-8: If there's a countMax, there must be a count (`countMax.empty() or count.exists()`) tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) (`offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))`) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa (`timeOfDay.empty() or when.empty()`)
186. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.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
188. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.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.occurrence[x].repeat.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
190. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.bounds[x]
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
Short | Length/Range of lengths, or (Start and/or end) limits
Control | 0..1
Type | Choice of: Duration, Range, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
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.occurrence[x].repeat.bounds[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
192. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.bounds[x]:boundsDuration
Slice Name | boundsDuration
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
Short | Length/Range of lengths, or (Start and/or end) limits
Control | 0..1
Type | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
194. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.count
Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
Short | Number of times to repeat
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Repetitions may be limited by end time or total occurrences.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
196. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.countMax
Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
Short | Maximum number of times to repeat
Control | 0..1
Type | positiveInt
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())`)
198. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.duration
Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
Short | How long when it happens
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Some activities are not instantaneous and need to be maintained for a period of time.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
200. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationMax
Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
Short | How long when it happens (Max)
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Some activities are not instantaneous and need to be maintained for a period of time.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
202. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit
Definition | The units of time for the duration, in UCUM units.
Short | s | min | h | d | wk | mo | a - unit of time (UCUM)
Control | 0..1
Binding | The codes SHALL be taken from UnitsOfTime (required to `http://hl7.org/fhir/ValueSet/units-of-time|4.0.1` ) A unit of time (units from UCUM).
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
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
204. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequency
Definition | The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
Short | Event occurs frequency times per period
Control | 0..1
Type | positiveInt
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 no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
206. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequencyMax
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
Short | Event occurs up to frequencyMax times per period
Control | 0..1
Type | positiveInt
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())`)
208. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.period
Definition | Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
Short | Event occurs frequency times per period
Control | 0..1
Type | decimal
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())`)
210. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodMax
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
Short | Upper limit of period (3-4 hours)
Control | 0..1
Type | decimal
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())`)
212. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit
Definition | The units of time for the period in UCUM units.
Short | s | min | h | d | wk | mo | a - unit of time (UCUM)
Control | 0..1
Binding | The codes SHALL be taken from UnitsOfTime (required to `http://hl7.org/fhir/ValueSet/units-of-time|4.0.1` ) A unit of time (units from UCUM).
Type | code
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())`)
214. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeek
Definition | If one or more days of week is provided, then the action happens only on the specified day(s).
Short | mon | tue | wed | thu | fri | sat | sun
Comments | If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
Control | 0..*
Binding | The codes SHALL be taken from DaysOfWeek (required to `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` )
Type | code
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())`)
216. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.timeOfDay
Definition | Specified time of day for action to take place.
Short | Time of day for action
Comments | When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
Control | 0..*
Type | time
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())`)
218. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when
Definition | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
Short | Code for time period of occurrence
Comments | When more than one event is listed, the event is tied to the union of the specified events.
Control | 0..*
Binding | The codes SHALL be taken from EventTiming (required to `http://hl7.org/fhir/ValueSet/event-timing|4.0.1` ) Real world event relating to the schedule.
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
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
220. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.offset
Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
Short | Minutes from event (before or after)
Control | 0..1
Type | unsignedInt
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())`)
222. ServiceRequest.occurrence[x]:occurrenceTiming.code
Definition | A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
Short | BID | TID | QID | AM | PM | QD | QOD | +
Comments | BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).
Control | 0..1
Binding | The codes SHOULD be taken from TimingAbbreviation (preferred to `http://hl7.org/fhir/ValueSet/timing-abbreviation|4.0.1` ) Code for a known / defined timing pattern.
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())`)
224. 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 | Preconditions for service
Control | 0..1
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to `http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1` ) 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
226. ServiceRequest.authoredOn
Definition | When the request transitioned to being actionable.
Short | 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())`) be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) (`empty() or toString().length()=25`)
228. ServiceRequest.requester
Definition | The individual who initiated the request and has responsibility for its activation.
Short | Prescriber of the requested 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 | 1..1
Type | Reference(BePractitionerRole)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | author, orderer
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
230. 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..0
Binding | For example codes, see ParticipantRoles (example to `http://hl7.org/fhir/ValueSet/participant-role|4.0.1` ) Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | specialty
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
232. ServiceRequest.performer
Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
Short | Requested performer - typically reference to practitionerroles
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..0
Type | Reference(BePractitionerRole)
Is Modifier | false
Must Support | true
Summary | true
Alternate Names | request recipient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
234. 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())`)
236. 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())`)
238. 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 | 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..1
Binding | For example codes, see ProcedureReasonCodes (example to `http://hl7.org/fhir/ValueSet/procedure-reason|4.0.1` ) Diagnosis or problem codes justifying the reason for requesting the service investigation.
Type | CodeableConcept
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())`)
240. 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 | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
242. 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())`)
244. 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
Must Support | true
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())`)
246. ServiceRequest.specimen
Definition | One or more specimens that the laboratory procedure will use.
Short | 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(Specimen)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
248. 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|4.0.1` ) Codes describing anatomical locations. May include laterality.
Type | CodeableConcept
Is Modifier | false
Must Support | true
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())`)
250. ServiceRequest.bodySite.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
252. ServiceRequest.bodySite.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.bodySite.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
254. ServiceRequest.bodySite.extension:bodyLaterality
Slice Name | bodyLaterality
Definition | An explicit statement of laterality of a lesion, or a treatment, etc.
Short | BeExtLaterality
Control | 0..1
Type | Extension(BeExtLaterality) (Extension Type: Coding)
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()`)
256. ServiceRequest.bodySite.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())`)
258. ServiceRequest.bodySite.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())`)
260. ServiceRequest.note
Definition | Any other notes and comments made about the service request. For example, internal billing notes.
Short | Comments
Control | 0..*
Type | Annotation(BeCodedAnnotation)
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())`)
262. ServiceRequest.note.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
264. ServiceRequest.note.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.note.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
266. ServiceRequest.note.extension:code
Slice Name | code
Definition | Codifies the content of an Element
Short | Code
Control | 0..1
Type | Extension(BeExtCodeableConcept) (Extension Type: CodeableConcept)
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()`)
268. ServiceRequest.note.extension: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
270. ServiceRequest.note.extension:code.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.note.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
272. ServiceRequest.note.extension:code.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies 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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept`
274. ServiceRequest.note.extension:code.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..1
Binding | For example codes, see BeVSRequestNoteType (example to `https://www.ehealth.fgov.be/standards/fhir/drp/ValueSet/be-vs-request-note-type` )
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
276. ServiceRequest.note.author[x]
Definition | The individual responsible for making the annotation.
Short | Individual responsible for the annotation
Comments | Organization is used when there's no need for specific attribution as to who made the comment.
Control | 0..1
Type | Choice of: Reference(Practitioner, Patient, RelatedPerson, Organization), string
[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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
278. ServiceRequest.note.time
Definition | Indicates when this particular annotation was made.
Short | When the annotation was made
Control | 0..1
Type | dateTime
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())`)
280. ServiceRequest.note.text
Definition | The text of the annotation in markdown format.
Short | The annotation - plain text without markdown is strongly recommended
Control | 1..1
Type | markdown
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())`)
282. 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())`)
284. 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())`)