EU Imaging Report R4
1.0.0-ballot - ci-build
150
EU Imaging Report R4
1.0.0-ballot - ci-build
150
EU Imaging Report R4, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging/StructureDefinition/ServiceRequestOrderEuImaging | Version: 1.0.0-ballot | ||||
| Standards status: Draft | Maturity Level: 1 | Computable Name: ServiceRequestOrderEuImaging | |||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
This profile on ServiceRequest represents the order for the Imaging Study and report. In DICOM this is referred
to as the Requested Procedure. The code element represents the requested imaging procedure type which includes
the requested modality.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason Constraints: ext-1 | |
   Slices for extension |
Content/Rules for all slices | |||
  extension:_datatype |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | |
  url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | |
 value[x] |
1..1 | string | Value of extension Fixed Value: CodeableReference | |
| extension:concept |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | |
| url |
1..1 | uri | "concept" | |
| extension:reference |
0..1 | Extension | R5: Reference to a resource (by instance) Constraints: ext-1 | |
| url |
1..1 | uri | "reference" | |
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason" | |
| Slices for value[x] |
Content/Rules for all slices | |||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 identifier:accessionNumber |
0..1 | AccessionNumberIdentifierEuImaging | Identifiers assigned to this order | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |
| Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:imaging |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 363679005 | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| code |
0..1 | CodeableConcept | Requested procedure Binding: ValueSet: Imaging Procedure Type (example) | |
 subject |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |
| note |
0..* | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:imaging | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | example | ValueSet: Imaging Procedure Type | 📦1.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
ServiceRequest | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason | |
| Slices for value[x] |
0..0 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Value of extension Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCodeableConcept |
0..0 | Value of extension | ||
| Slices for identifier |
0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:accessionNumber |
0..1 | AccessionNumberIdentifierEuImaging | Identifiers assigned to this order | |
| Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:imaging |
1..1 | CodeableConcept | Classification of service Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 363679005 | |
 code |
0..1 | CodeableConcept | Requested procedure Binding: ValueSet: Imaging Procedure Type (example) | |
| subject |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |
| supportingInfo |
||||
 Slices for extension |
Content/Rules for all slices | |||
| extension:codeableConcept |
0..* | CodeableConcept | R5: supportingInfo additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.supportingInfo | |
| note |
0..* | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code | Base | example | ValueSet: Imaging Procedure Type | 📦1.0.0-ballot | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:_datatype |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | |||||
| value[x] |
1..1 | string | Value of extension Fixed Value: CodeableReference | |||||
| extension:concept |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "concept" | |||||
| value[x] |
0..1 | CodeableConcept | Reference to a concept (by class) | |||||
| extension:reference |
0..1 | Extension | R5: Reference to a resource (by instance) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "reference" | |||||
| value[x] |
0..1 | Reference(Cross-version Profile for R5.Condition for use in FHIR R4(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4(0.1.0) | DiagnosticReport | Cross-version Profile for R5.DocumentReference for use in FHIR R4(0.1.0) | Media | Cross-version Profile for R5.DetectedIssue for use in FHIR R4(0.1.0) | DetectedIssue) | Reference to a resource (by instance) | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason" | |||||
| Slices for value[x] |
Content/Rules for all slices | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:accessionNumber |
0..1 | AccessionNumberIdentifierEuImaging | Identifiers assigned to this order | |||||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |||||
| replaces |
0..* | Reference(ServiceRequest) | What request replaces | |||||
| requisition |
0..1 | Identifier | Composite Request ID | |||||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |||||
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |||||
| Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:imaging |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 363679005 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |||||
| code |
0..1 | CodeableConcept | Requested procedure Binding: ValueSet: Imaging Procedure Type (example) | |||||
| orderDetail |
C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
 quantity[x] |
0..1 | Service amount | ||||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |||||
| occurrence[x] |
0..1 | When service should occur | ||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | ||||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
0..1 | dateTime | Date request signed | |||||
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |||||
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | |||||
| performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |||||
| locationCode |
0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | |||||
| locationReference |
0..* | Reference(Location) | Requested location | |||||
| reasonCode |
0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:codeableConcept |
0..* | CodeableConcept | R5: supportingInfo additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.supportingInfo | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| specimen |
0..* | Reference(Specimen) | Procedure Samples | |||||
| bodySite |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:imaging | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | example | ValueSet: Imaging Procedure Type | 📦1.0.0-ballot | This IG |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.3 |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.supportingInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
This structure is derived from ServiceRequest
Summary
Mandatory: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason Constraints: ext-1 | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:_datatype |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | |
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | |
| value[x] |
1..1 | string | Value of extension Fixed Value: CodeableReference | |
| extension:concept |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | |
| url |
1..1 | uri | "concept" | |
| extension:reference |
0..1 | Extension | R5: Reference to a resource (by instance) Constraints: ext-1 | |
| url |
1..1 | uri | "reference" | |
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason" | |
| Slices for value[x] |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:accessionNumber |
0..1 | AccessionNumberIdentifierEuImaging | Identifiers assigned to this order | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |
| Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:imaging |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 363679005 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| code |
0..1 | CodeableConcept | Requested procedure Binding: ValueSet: Imaging Procedure Type (example) | |
| subject |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |
| note |
0..* | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:imaging | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | example | ValueSet: Imaging Procedure Type | 📦1.0.0-ballot | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
ServiceRequest | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason | |
| Slices for value[x] |
0..0 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Value of extension Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCodeableConcept |
0..0 | Value of extension | ||
| Slices for identifier |
0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:accessionNumber |
0..1 | AccessionNumberIdentifierEuImaging | Identifiers assigned to this order | |
| Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:imaging |
1..1 | CodeableConcept | Classification of service Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 363679005 | |
| code |
0..1 | CodeableConcept | Requested procedure Binding: ValueSet: Imaging Procedure Type (example) | |
| subject |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |
| supportingInfo |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:codeableConcept |
0..* | CodeableConcept | R5: supportingInfo additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.supportingInfo | |
| note |
0..* | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code | Base | example | ValueSet: Imaging Procedure Type | 📦1.0.0-ballot | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: prr-1 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:_datatype |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | |||||
| value[x] |
1..1 | string | Value of extension Fixed Value: CodeableReference | |||||
| extension:concept |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "concept" | |||||
| value[x] |
0..1 | CodeableConcept | Reference to a concept (by class) | |||||
| extension:reference |
0..1 | Extension | R5: Reference to a resource (by instance) Constraints: ext-1 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| url |
1..1 | uri | "reference" | |||||
| value[x] |
0..1 | Reference(Cross-version Profile for R5.Condition for use in FHIR R4(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4(0.1.0) | DiagnosticReport | Cross-version Profile for R5.DocumentReference for use in FHIR R4(0.1.0) | Media | Cross-version Profile for R5.DetectedIssue for use in FHIR R4(0.1.0) | DetectedIssue) | Reference to a resource (by instance) | |||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason" | |||||
| Slices for value[x] |
Content/Rules for all slices | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:accessionNumber |
0..1 | AccessionNumberIdentifierEuImaging | Identifiers assigned to this order | |||||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |||||
| replaces |
0..* | Reference(ServiceRequest) | What request replaces | |||||
| requisition |
0..1 | Identifier | Composite Request ID | |||||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |||||
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |||||
| Slices for category |
1..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:imaging |
1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 363679005 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |||||
| code |
0..1 | CodeableConcept | Requested procedure Binding: ValueSet: Imaging Procedure Type (example) | |||||
| orderDetail |
C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
0..1 | Service amount | ||||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |||||
| occurrence[x] |
0..1 | When service should occur | ||||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | ||||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
0..1 | dateTime | Date request signed | |||||
| requester |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |||||
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | |||||
| performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |||||
| locationCode |
0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | |||||
| locationReference |
0..* | Reference(Location) | Requested location | |||||
| reasonCode |
0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:codeableConcept |
0..* | CodeableConcept | R5: supportingInfo additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.supportingInfo | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| specimen |
0..* | Reference(Specimen) | Procedure Samples | |||||
| bodySite |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:imaging | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | example | ValueSet: Imaging Procedure Type | 📦1.0.0-ballot | This IG |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.3 |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.supportingInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
This structure is derived from ServiceRequest
Summary
Mandatory: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.imaging#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-10-13
