Referral Prescription, published by . This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/referral/ and changes regularly. See the Directory of published versions
Draft as of 2024-09-23 |
Definitions for the be-annex-81 resource profile.
Guidance on how to interpret the contents of this table can be found here
0. ServiceRequest | |
Invariants | be-inv-annex-81-based-on: An approved Annex81 is always based on a request by a nurse (intent = 'order' implies basedOn.exists() ) |
2. ServiceRequest.extension | |
Control | 1..? |
Slicing | This element introduces a set of slices on ServiceRequest.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. ServiceRequest.extension:validity | |
Slice Name | validity |
Short | Validity period of the prescription |
Control | 1..1 |
Type | Extension(BeValidityPeriod) (Extension Type: Period) |
Must Support | true |
6. ServiceRequest.extension:latest | |
Slice Name | latest |
Short | Request must be executed before |
Control | 0..1 |
Type | Extension(BeLatestEndDate) (Extension Type: dateTime(BeYearMonthDay)) |
Must Support | true |
8. ServiceRequest.extension:performerType | |
Slice Name | performerType |
Short | Discipline of provider. Replaces .performerType because of wrong cardinality |
Control | 0..* |
Type | Extension(BePerformerType) (Extension Type: CodeableConcept) |
Must Support | true |
10. ServiceRequest.extension:performerType.value[x] | |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
12. ServiceRequest.extension:performerType.value[x].coding | |
14. ServiceRequest.extension:performerType.value[x].coding.system | |
Pattern Value | https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty |
16. ServiceRequest.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Slicing | This element introduces a set of slices on ServiceRequest.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
18. ServiceRequest.identifier:UHMEP | |
Slice Name | UHMEP |
Short | Reference ID of the UHMEP once available there |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
20. ServiceRequest.identifier:UHMEP.system | |
Control | 1..? |
Fixed Value | https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep |
22. ServiceRequest.identifier:UHMEP.value | |
Control | 1..? |
24. ServiceRequest.identifier:SHORT | |
Slice Name | SHORT |
Short | Patient friendly ID (UHMEP SHORT) |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Invariants | 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() ) |
26. ServiceRequest.identifier:SHORT.system | |
Control | 1..? |
Fixed Value | https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short |
28. ServiceRequest.identifier:SHORT.value | |
Control | 1..? |
30. ServiceRequest.basedOn | |
Type | Reference(BeAnnex81) |
32. ServiceRequest.category | |
34. ServiceRequest.category.coding | |
36. ServiceRequest.category.coding.system | |
Fixed Value | http://snomed.info/sct |
38. ServiceRequest.category.coding.code | |
Fixed Value | 9632001 |
40. ServiceRequest.code | |
Pattern Value | { |
42. ServiceRequest.occurrence[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] . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
44. 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] |
46. ServiceRequest.occurrence[x]:occurrenceTiming.repeat | |
48. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequency | |
Pattern Value | 1 |
50. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.period | |
Pattern Value | 1 |
52. ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | |
Pattern Value | wk |
54. ServiceRequest.authoredOn | |
Control | 1..? |
Must Support | true |
Invariants | be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) (empty() or toString().length()=25 ) |
56. ServiceRequest.reasonCode | |
Control | 1..? |
Binding | The codes SHALL be taken from BeVSAnnex81ReasonCode (required to https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-annex-81-reason-code ) |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
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() )be-inv-annex-81-based-on: An approved Annex81 is always based on a request by a nurse ( intent = 'order' implies basedOn.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: |
6. ServiceRequest.extension:validity | |
Slice Name | validity |
Definition | Begin and enddate 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 |
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: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(BeYearMonthDay)) |
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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
10. ServiceRequest.extension:performerType | |
Slice Name | performerType |
Definition | Optional Extension Element - found in all resources. |
Short | Discipline of provider. Replaces .performerType because of wrong 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 |
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.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on ServiceRequest.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
14. ServiceRequest.extension:performerType.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/referral/StructureDefinition/be-ext-performer-type |
16. ServiceRequest.extension:performerType.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 | Unless not suitable, these codes SHALL be taken from For codes, see BeVSCdHcParty (extensible to https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-cd-hcparty ) |
Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. 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()) |
20. ServiceRequest.identifier | |
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
Short | Identifiers assigned to this order |
Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on ServiceRequest.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
22. 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 |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. 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 IdentifierUsehttp://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())) |
26. 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/referral/NamingSystem/uhmep |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. 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 | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. 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 |
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() ) |
32. 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 IdentifierUsehttp://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())) |
34. 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/referral/NamingSystem/uhmep-short |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. 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 | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. ServiceRequest.basedOn | |
Definition | Plan/proposal/order fulfilled by this request. |
Short | What request fulfills |
Control | 0..* |
Type | Reference(BeAnnex81, CarePlan, ServiceRequest, MedicationRequest) |
Is Modifier | false |
Summary | true |
Alternate Names | fulfills |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. 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 RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/request-status|4.0.1 )The status of a service order. |
Type | code |
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. 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 RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 (required to http://hl7.org/fhir/ValueSet/request-intent|4.0.1 )The kind of service request. |
Type | code |
Is Modifier | true because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. 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())) |
46. 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 | 0..1 |
Binding | For example codes, see ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code (example to http://hl7.org/fhir/ValueSet/procedure-code )Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Alternate Names | service requested |
Pattern Value | { |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
48. 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(Patient, Group, Location, Device) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
50. ServiceRequest.occurrence[x] | |
Definition | The date/time at which the requested service should occur. |
Short | When service should occur |
Control | 0..1 |
Type | Choice of: dateTime, Period, Timing |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
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 Open, and can be differentiated using the following discriminators: |
52. ServiceRequest.occurrence[x]:occurrenceTiming | |
Slice Name | occurrenceTiming |
Definition | The date/time at which the requested service should occur. |
Short | 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 |
Summary | true |
Alternate Names | schedule |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. 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()) |
56. 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 ) |
58. 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 |
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 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 |
Control | 10..* |
Binding | The codes SHALL be taken from For example codes, see BeVSAnnex81ReasonCodehttp://hl7.org/fhir/ValueSet/procedure-reason (required to https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-annex-81-reason-code ) |
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())) |
Guidance on how to interpret the contents of this table can be found here
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() )be-inv-annex-81-based-on: An approved Annex81 is always based on a request by a nurse ( intent = 'order' implies basedOn.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 )A human language.
| ||||
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: | ||||
16. ServiceRequest.extension:validity | |||||
Slice Name | validity | ||||
Definition | Begin and enddate 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 | ||||
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: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(BeYearMonthDay)) | ||||
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() ) | ||||
20. ServiceRequest.extension:performerType | |||||
Slice Name | performerType | ||||
Definition | Optional Extension Element - found in all resources. | ||||
Short | Discipline of provider. Replaces .performerType because of wrong 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 | ||||
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.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 | ||||
24. ServiceRequest.extension:performerType.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: | ||||
26. ServiceRequest.extension:performerType.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/referral/StructureDefinition/be-ext-performer-type | ||||
28. ServiceRequest.extension:performerType.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 | Unless not suitable, these codes SHALL be taken from BeVSCdHcParty (extensible to https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-cd-hcparty ) | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. ServiceRequest.extension:performerType.value[x].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 | ||||
32. ServiceRequest.extension:performerType.value[x].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.value[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
34. ServiceRequest.extension:performerType.value[x].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()) ) | ||||
36. ServiceRequest.extension:performerType.value[x].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 | ||||
38. ServiceRequest.extension:performerType.value[x].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.extension.value[x].coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
40. ServiceRequest.extension:performerType.value[x].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. | ||||
Pattern Value | https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. ServiceRequest.extension:performerType.value[x].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()) ) | ||||
44. ServiceRequest.extension:performerType.value[x].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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
46. ServiceRequest.extension:performerType.value[x].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()) ) | ||||
48. ServiceRequest.extension:performerType.value[x].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()) ) | ||||
50. ServiceRequest.extension:performerType.value[x].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()) ) | ||||
52. 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() ) | ||||
54. ServiceRequest.identifier | |||||
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. | ||||
Short | Identifiers assigned to this order | ||||
Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on ServiceRequest.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
56. 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 | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. 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 | ||||
60. 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: | ||||
62. 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()) ) | ||||
64. 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 )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()) ) | ||||
66. 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/referral/NamingSystem/uhmep | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
68. 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 | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. 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()) ) | ||||
72. 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()) ) | ||||
74. 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 | ||||
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() ) | ||||
76. 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 | ||||
78. 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: | ||||
80. 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()) ) | ||||
82. 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 )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()) ) | ||||
84. 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/referral/NamingSystem/uhmep-short | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
86. 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 | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
88. 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()) ) | ||||
90. 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()) ) | ||||
92. 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()) ) | ||||
94. 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()) ) | ||||
96. ServiceRequest.basedOn | |||||
Definition | Plan/proposal/order fulfilled by this request. | ||||
Short | What request fulfills | ||||
Control | 0..* | ||||
Type | Reference(BeAnnex81) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Alternate Names | fulfills | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
98. 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()) ) | ||||
100. 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()) ) | ||||
102. 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 | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
104. 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 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 | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
106. 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 | 0..* | ||||
Binding | For example codes, see ServiceRequestCategoryCodes (example to http://hl7.org/fhir/ValueSet/servicerequest-category )Classification of the requested service. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
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()) ) | ||||
108. 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 | ||||
110. 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: | ||||
112. 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()) ) | ||||
114. 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 | ||||
116. 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: | ||||
118. 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()) ) | ||||
120. 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()) ) | ||||
122. 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()) ) | ||||
124. 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()) ) | ||||
126. 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()) ) | ||||
128. 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()) ) | ||||
130. 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()) ) | ||||
132. 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()) ) | ||||
134. 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 | 0..1 | ||||
Binding | For example codes, see ProcedureCodes(SNOMEDCT) (example to http://hl7.org/fhir/ValueSet/procedure-code )Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Alternate Names | service requested | ||||
Pattern Value | { | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
136. ServiceRequest.orderDetail | |||||
Definition | Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. | ||||
Short | Additional order information | ||||
Comments | For information from the medical record intended to support the delivery of the requested services, use the | ||||
Control | 0..* This element is affected by the following invariants: prr-1 | ||||
Binding | For example codes, see ServiceRequestOrderDetailsCodes (example to http://hl7.org/fhir/ValueSet/servicerequest-orderdetail )Codified order entry details which are based on order context. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Alternate Names | detailed instructions | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
138. 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()) ) | ||||
140. 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(Patient, Group, Location, Device) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
142. 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()) ) | ||||
144. ServiceRequest.occurrence[x] | |||||
Definition | The date/time at which the requested service should occur. | ||||
Short | When service should occur | ||||
Control | 0..1 | ||||
Type | Choice of: dateTime, Period, Timing | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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 Open, and can be differentiated using the following discriminators: | ||||
146. ServiceRequest.occurrence[x]:occurrenceTiming | |||||
Slice Name | occurrenceTiming | ||||
Definition | The date/time at which the requested service should occur. | ||||
Short | When service should occur | ||||
Control | 0..1 | ||||
Type | Timing | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | true | ||||
Alternate Names | schedule | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
148. 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 | ||||
150. 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: | ||||
152. 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() ) | ||||
154. 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()) ) | ||||
156. 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() ) | ||||
158. 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 | ||||
160. 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: | ||||
162. 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()) ) | ||||
164. 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 | ||||
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()) ) | ||||
166. 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()) ) | ||||
168. 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 | ||||
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()) ) | ||||
170. 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()) ) | ||||
172. 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 | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
174. 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 | ||||
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 | ||||
Pattern Value | 1 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
176. 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()) ) | ||||
178. 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 | ||||
Pattern Value | 1 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
180. 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()) ) | ||||
182. 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 | ||||
Pattern Value | wk | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
184. 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()) ) | ||||
186. 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()) ) | ||||
188. 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 | ||||
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()) ) | ||||
190. 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()) ) | ||||
192. 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 )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()) ) | ||||
194. 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 )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()) ) | ||||
196. 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 ) | ||||
198. ServiceRequest.requester | |||||
Definition | The individual who initiated the request and has responsibility for its activation. | ||||
Short | Who/what is requesting service | ||||
Comments | This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource. | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Alternate Names | author, orderer | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
200. ServiceRequest.performerType | |||||
Definition | Desired type of performer for doing the requested service. | ||||
Short | Performer role | ||||
Comments | This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”. | ||||
Control | 0..1 | ||||
Binding | For example codes, see ParticipantRoles (example to http://hl7.org/fhir/ValueSet/participant-role )Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Alternate Names | specialty | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
202. ServiceRequest.performer | |||||
Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. | ||||
Short | Requested performer | ||||
Comments | If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). | ||||
Control | 0..* | ||||
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Alternate Names | request recipient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
204. 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 (example to http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType )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()) ) | ||||
206. 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()) ) | ||||
208. 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 | ||||
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 | ||||
Control | 1..* | ||||
Binding | The codes SHALL be taken from BeVSAnnex81ReasonCode (required to https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-annex-81-reason-code ) | ||||
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()) ) | ||||
210. 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 | ||||
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 | ||||
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()) ) | ||||
212. 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()) ) | ||||
214. 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 | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | Ask at order entry question, AOE | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
216. 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()) ) | ||||
218. ServiceRequest.bodySite | |||||
Definition | Anatomic location where the procedure should be performed. This is the target site. | ||||
Short | Location on Body | ||||
Comments | Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure. | ||||
Control | 0..* | ||||
Binding | For example codes, see SNOMEDCTBodyStructures (example to http://hl7.org/fhir/ValueSet/body-site )Codes describing anatomical locations. May include laterality. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible. | ||||
Alternate Names | location | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
220. ServiceRequest.note | |||||
Definition | Any other notes and comments made about the service request. For example, internal billing notes. | ||||
Short | Comments | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
222. 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()) ) | ||||
224. 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()) ) |