FHIR Imaging ServiceRequest Profile IG
0.1.0 -
FHIR Imaging ServiceRequest Profile IG
0.1.0 -
FHIR Imaging ServiceRequest Profile IG, published by HL7 International / Imaging Integration. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/imaging-service-request-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/imaging-service-request-ig/StructureDefinition/imaging-service-request | Version: 0.1.0 | |||
| Computable Name: ImagingServiceRequestProfile | ||||
DICOM MWL Imaging Service Request Mapping to ServiceRequest
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: asn-1, bdystr-1, prr-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
  Slices for identifier |
Σ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type |
   identifier:accessionNumber |
Σ | 1..1 | Identifier | Accession ID |
  use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
  type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
 value |
C | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:placerOrder |
Σ | 0..1 | Identifier | Placer Identifier |
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Placer Identifier | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| value |
C | 1..1 | string | The value that is unique Example General: 123456 |
 identifier:fillerOrder |
Σ | 0..1 | Identifier | Filler Identifier |
 use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Filler Identifier | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| value |
C | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!Σ | 1..1 | code | draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order |
| category |
Σ | 0..* | 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 |
1..1 | string | Representation defined by the system Fixed Value: Imaging | |
| 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 |
 subject |
Σ | 1..1 | Reference(Patient - DICOM MWL Patient Mapping) | Individual or Entity the service is ordered for |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier:accessionNumber.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:accessionNumber.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:placerOrder.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:placerOrder.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:fillerOrder.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:fillerOrder.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍6.0.0-ballot3 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| asn-1 | error | ServiceRequest | asNeededFor SHALL only be present if asNeeded is empty or true |
asNeededFor.empty() or (asNeeded = true or asNeeded.empty())
|
| bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').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())
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request for a service to be performed | |
| Slices for identifier |
1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type | |
| identifier:accessionNumber |
1..1 | Identifier | Accession ID | |
 type |
1..1 | CodeableConcept | Description of identifier 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
| value |
1..1 | string | The value that is unique | |
| identifier:placerOrder |
0..1 | Identifier | Placer Identifier | |
| type |
1..1 | CodeableConcept | Description of identifier 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Placer Identifier | |
| value |
1..1 | string | The value that is unique | |
| identifier:fillerOrder |
0..1 | Identifier | Filler Identifier | |
| type |
1..1 | CodeableConcept | Description of identifier 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Filler Identifier | |
| value |
1..1 | string | The value that is unique | |
| intent |
1..1 | code | proposal | plan | directive | order + Required Pattern: order | |
| category |
0..* | 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 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Imaging | |
| subject |
1..1 | Reference(Patient - DICOM MWL Patient Mapping) | Individual or Entity the service is ordered for | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: asn-1, bdystr-1, 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: AllLanguages (required): IETF language tag for 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type | ||||
| identifier:accessionNumber |
Σ | 1..1 | Identifier | Accession ID | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Accession ID | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:placerOrder |
Σ | 0..1 | Identifier | Placer Identifier | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Placer Identifier | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:fillerOrder |
Σ | 0..1 | Identifier | Filler Identifier | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Filler Identifier | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest | RequestOrchestration | NutritionOrder) | 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 | entered-in-error | ended | completed | revoked | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order | ||||
| category |
Σ | 0..* | 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 |
1..1 | string | Representation defined by the system Fixed Value: Imaging | |||||
| 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 |
ΣC | 0..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: ProcedureCodesSNOMEDCT (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred. | ||||
| orderDetail |
ΣC | 0..* | BackboneElement | Additional information about the request | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| parameterFocus |
0..1 | CodeableReference(Device | DeviceDefinition | DeviceRequest | SupplyRequest | Medication | MedicationRequest | BiologicallyDerivedProduct | Substance) | The context of the order details by reference | |||||
| parameter |
Σ | 1..* | BackboneElement | The parameter details for the service being requested | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. | ||||
 value[x] |
Σ | 1..1 | The value for the order detail | |||||
| valueQuantity |
Quantity | |||||||
| valueRatio |
Ratio | |||||||
| valueRange |
Range | |||||||
| valueBoolean |
boolean | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valuePeriod |
Period | |||||||
| quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(Patient - DICOM MWL Patient Mapping) | Individual or Entity the service is ordered for | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record | ||||
| 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 |
Σ | 0..1 | boolean | Perform the service "as needed" | ||||
| asNeededFor |
ΣC | 0..* | CodeableConcept | Specified criteria for the 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. | ||||
| authoredOn |
Σ | 0..1 | dateTime | Date request signed | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | Group) | 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 | Group) | Requested performer | ||||
| location |
Σ | 0..* | CodeableReference(Location) | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| reason |
Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue | Procedure) | Reason or indication for requesting the service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | CodeableReference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
ΣC | 0..* | CodeableConcept | Coded location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| bodyStructure |
ΣC | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
0..* | BackboneElement | Patient or consumer-oriented instructions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| instruction[x] |
Σ | 0..1 | Patient or consumer-oriented instructions | |||||
| instructionMarkdown |
markdown | |||||||
| instructionReference |
Reference(DocumentReference) | |||||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | required | All Languages | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:accessionNumber.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:accessionNumber.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:placerOrder.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:placerOrder.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:fillerOrder.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:fillerOrder.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.priority | Base | required | RequestPriority | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.code | Base | example | Procedure Codes (SNOMED CT) | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.orderDetail.parameter.code | Base | example | Servicerequest OrderDetail Parameter Code | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.asNeededFor | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.location | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v6.5 |
| ServiceRequest.reason | Base | example | Procedure Reason Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍6.0.0-ballot3 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| asn-1 | error | ServiceRequest | asNeededFor SHALL only be present if asNeeded is empty or true |
asNeededFor.empty() or (asNeeded = true or asNeeded.empty())
|
| bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').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())
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
Summary
Mandatory: 4 elements(4 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: asn-1, bdystr-1, prr-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type |
| identifier:accessionNumber |
Σ | 1..1 | Identifier | Accession ID |
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| value |
C | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:placerOrder |
Σ | 0..1 | Identifier | Placer Identifier |
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Placer Identifier | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| value |
C | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:fillerOrder |
Σ | 0..1 | Identifier | Filler Identifier |
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Filler Identifier | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| value |
C | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!Σ | 1..1 | code | draft | active | on-hold | entered-in-error | ended | completed | revoked | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order |
| category |
Σ | 0..* | 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 |
1..1 | string | Representation defined by the system Fixed Value: Imaging | |
| 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 |
| subject |
Σ | 1..1 | Reference(Patient - DICOM MWL Patient Mapping) | Individual or Entity the service is ordered for |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier:accessionNumber.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:accessionNumber.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:placerOrder.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:placerOrder.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:fillerOrder.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:fillerOrder.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍6.0.0-ballot3 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| asn-1 | error | ServiceRequest | asNeededFor SHALL only be present if asNeeded is empty or true |
asNeededFor.empty() or (asNeeded = true or asNeeded.empty())
|
| bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').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())
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request for a service to be performed | |
| Slices for identifier |
1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type | |
| identifier:accessionNumber |
1..1 | Identifier | Accession ID | |
| type |
1..1 | CodeableConcept | Description of identifier 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
| value |
1..1 | string | The value that is unique | |
| identifier:placerOrder |
0..1 | Identifier | Placer Identifier | |
| type |
1..1 | CodeableConcept | Description of identifier 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Placer Identifier | |
| value |
1..1 | string | The value that is unique | |
| identifier:fillerOrder |
0..1 | Identifier | Filler Identifier | |
| type |
1..1 | CodeableConcept | Description of identifier 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://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Filler Identifier | |
| value |
1..1 | string | The value that is unique | |
| intent |
1..1 | code | proposal | plan | directive | order + Required Pattern: order | |
| category |
0..* | 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 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Imaging | |
| subject |
1..1 | Reference(Patient - DICOM MWL Patient Mapping) | Individual or Entity the service is ordered for | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: asn-1, bdystr-1, 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: AllLanguages (required): IETF language tag for 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type | ||||
| identifier:accessionNumber |
Σ | 1..1 | Identifier | Accession ID | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Accession ID | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:placerOrder |
Σ | 0..1 | Identifier | Placer Identifier | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Placer Identifier | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:fillerOrder |
Σ | 0..1 | Identifier | Filler Identifier | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?! | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
1..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Filler Identifier | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest | RequestOrchestration | NutritionOrder) | 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 | entered-in-error | ended | completed | revoked | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order | ||||
| category |
Σ | 0..* | 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 |
1..1 | string | Representation defined by the system Fixed Value: Imaging | |||||
| 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 |
ΣC | 0..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: ProcedureCodesSNOMEDCT (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred. | ||||
| orderDetail |
ΣC | 0..* | BackboneElement | Additional information about the request | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| parameterFocus |
0..1 | CodeableReference(Device | DeviceDefinition | DeviceRequest | SupplyRequest | Medication | MedicationRequest | BiologicallyDerivedProduct | Substance) | The context of the order details by reference | |||||
| parameter |
Σ | 1..* | BackboneElement | The parameter details for the service being requested | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. | ||||
| value[x] |
Σ | 1..1 | The value for the order detail | |||||
| valueQuantity |
Quantity | |||||||
| valueRatio |
Ratio | |||||||
| valueRange |
Range | |||||||
| valueBoolean |
boolean | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valuePeriod |
Period | |||||||
| quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(Patient - DICOM MWL Patient Mapping) | Individual or Entity the service is ordered for | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record | ||||
| 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 |
Σ | 0..1 | boolean | Perform the service "as needed" | ||||
| asNeededFor |
ΣC | 0..* | CodeableConcept | Specified criteria for the 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. | ||||
| authoredOn |
Σ | 0..1 | dateTime | Date request signed | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | Group) | 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 | Group) | Requested performer | ||||
| location |
Σ | 0..* | CodeableReference(Location) | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| reason |
Σ | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue | Procedure) | Reason or indication for requesting the service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | CodeableReference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
ΣC | 0..* | CodeableConcept | Coded location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| bodyStructure |
ΣC | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
0..* | BackboneElement | Patient or consumer-oriented instructions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| instruction[x] |
Σ | 0..1 | Patient or consumer-oriented instructions | |||||
| instructionMarkdown |
markdown | |||||||
| instructionReference |
Reference(DocumentReference) | |||||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | required | All Languages | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:accessionNumber.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:accessionNumber.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:placerOrder.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:placerOrder.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:fillerOrder.use | Base | required | IdentifierUse | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.identifier:fillerOrder.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.priority | Base | required | RequestPriority | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.code | Base | example | Procedure Codes (SNOMED CT) | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.orderDetail.parameter.code | Base | example | Servicerequest OrderDetail Parameter Code | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.asNeededFor | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.location | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v6.5 |
| ServiceRequest.reason | Base | example | Procedure Reason Codes | 📍6.0.0-ballot3 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍6.0.0-ballot3 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| asn-1 | error | ServiceRequest | asNeededFor SHALL only be present if asNeeded is empty or true |
asNeededFor.empty() or (asNeeded = true or asNeeded.empty())
|
| bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').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())
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
Summary
Mandatory: 4 elements(4 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Imaging Integration.
Package hl7.fhir.uv.imaging-service-request-ig#0.1.0 based on FHIR 6.0.0-ballot3.
Generated 2025-10-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change