Belgian MyCareNet Profiles
2.2.1 - STU Belgium flag

Belgian MyCareNet Profiles, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/mycarenet/ and changes regularly. See the Directory of published versions

Resource Profile: MyCareNet eAgreement ServiceRequest BE profile

Official URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-eagreementservicerequest Version: 2.2.1
Standards status: Trial-use Maturity Level: 1 Computable Name: BeMyCareNetEagreementServiceRequest
Other Identifiers: OID:2.16.840.1.113883.4.642.40.200.6.42.10

The ServiceRequest profile for use in the different eAgreement flows from MyCareNet.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1, mcn-2
ServiceRequest.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.contained This element must be supported. 0..1 BeMyCareNetEagreementServiceRequestBinary Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Pure binary content defined by a format other than FHIR
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
Fixed Value: active (no extensions allowed)
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
ServiceRequest.category This element must be supported. This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.category.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
ServiceRequest.category.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
ServiceRequest.code.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
ServiceRequest.code.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.code.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
ServiceRequest.quantity[x] This element must be supported. This element is included in summaries. 0..1 Quantity Service amount
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(BePatient) Individual or Entity the service is ordered for
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. This element is included in summaries. 1..1 Reference(BePractitionerRole | BePractitioner) Who/what is requesting service
ServiceRequest.supportingInfo This element must be supported. 0..1 Reference(Resource) Additional clinical information
ServiceRequest.supportingInfo.reference This element must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

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.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.

Constraints

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()
mcn-2 error ServiceRequest If identifier is not present: supportingInfo and contained SHALL be present. identifier.empty() implies (supportingInfo.exists() and contained.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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: mcn-2
ServiceRequest.id This element must be supported. 1..1 id Logical id of this artifact
ServiceRequest.contained This element must be supported. 0..1 BeMyCareNetEagreementServiceRequestBinary Pure binary content defined by a format other than FHIR
ServiceRequest.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Fixed Value: active (no extensions allowed)
ServiceRequest.category This element must be supported. 1..1 CodeableConcept Classification of service
ServiceRequest.category.coding 1..1 Coding Code defined by a terminology system
ServiceRequest.category.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.code 1..1 code Symbol in syntax defined by the system
ServiceRequest.code This element must be supported. 1..1 CodeableConcept What is being requested/ordered
ServiceRequest.code.coding 1..1 Coding Code defined by a terminology system
ServiceRequest.code.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.code.coding.code 1..1 code Symbol in syntax defined by the system
ServiceRequest.quantity[x] This element must be supported. 0..1 Quantity Service amount
ServiceRequest.subject This element must be supported. 1..1 Reference(BePatient) Individual or Entity the service is ordered for
ServiceRequest.authoredOn This element must be supported. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. 1..1 Reference(BePractitionerRole | BePractitioner) Who/what is requesting service
ServiceRequest.supportingInfo This element must be supported. 0..1 Reference(Resource) Additional clinical information
ServiceRequest.supportingInfo.reference This element must be supported. 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
mcn-2 error ServiceRequest If identifier is not present: supportingInfo and contained SHALL be present. identifier.empty() implies (supportingInfo.exists() and contained.exists())
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1, mcn-2
ServiceRequest.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ServiceRequest.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
ServiceRequest.contained This element must be supported. 0..1 BeMyCareNetEagreementServiceRequestBinary Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Pure binary content defined by a format other than FHIR
ServiceRequest.extension 0..* Extension Additional content defined by implementations
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.identifier This element is included in summaries. 0..* Identifier Identifiers assigned to this order
ServiceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
ServiceRequest.basedOn This element is included in summaries. 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Composite Request ID
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
Fixed Value: active (no extensions allowed)
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
ServiceRequest.category This element must be supported. This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.category.id 0..1 string Unique id for inter-element referencing
ServiceRequest.category.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.category.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
ServiceRequest.category.coding.id 0..1 string Unique id for inter-element referencing
ServiceRequest.category.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.category.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
ServiceRequest.category.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
ServiceRequest.category.coding.display This element is included in summaries. 0..1 string Representation defined by the system
ServiceRequest.category.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
ServiceRequest.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
ServiceRequest.code.id 0..1 string Unique id for inter-element referencing
ServiceRequest.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.code.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
ServiceRequest.code.coding.id 0..1 string Unique id for inter-element referencing
ServiceRequest.code.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.code.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.code.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
ServiceRequest.code.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
ServiceRequest.code.coding.display This element is included in summaries. 0..1 string Representation defined by the system
ServiceRequest.code.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
ServiceRequest.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
ServiceRequest.orderDetail This element is included in summaries. C 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
ServiceRequest.quantity[x] This element must be supported. This element is included in summaries. 0..1 Quantity Service amount
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(BePatient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element is included in summaries. 0..1 When service should occur
ServiceRequest.occurrence[x].occurrenceDateTime dateTime
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.asNeeded[x] This element is included in summaries. 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.
ServiceRequest.asNeeded[x].asNeededBoolean boolean
ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. This element is included in summaries. 1..1 Reference(BePractitionerRole | BePractitioner) Who/what is requesting service
ServiceRequest.performerType This element is included in summaries. 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.
ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
ServiceRequest.locationCode This element is included in summaries. 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
ServiceRequest.locationReference This element is included in summaries. 0..* Reference(Location) Requested location
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
ServiceRequest.supportingInfo This element must be supported. 0..1 Reference(Resource) Additional clinical information
ServiceRequest.supportingInfo.id 0..1 string Unique id for inter-element referencing
ServiceRequest.supportingInfo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.supportingInfo.reference This element must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.supportingInfo.type This element is included in summaries. 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).
ServiceRequest.supportingInfo.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.supportingInfo.display This element is included in summaries. 0..1 string Text alternative for the resource
ServiceRequest.specimen This element is included in summaries. 0..* Reference(Specimen) Procedure Samples
ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ServiceRequest.note 0..* Annotation Comments
ServiceRequest.patientInstruction This element is included in summaries. 0..1 string Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

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.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
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.5
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.

Constraints

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()
mcn-2 error ServiceRequest If identifier is not present: supportingInfo and contained SHALL be present. identifier.empty() implies (supportingInfo.exists() and contained.exists())
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1, mcn-2
ServiceRequest.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.contained This element must be supported. 0..1 BeMyCareNetEagreementServiceRequestBinary Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Pure binary content defined by a format other than FHIR
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
Fixed Value: active (no extensions allowed)
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
ServiceRequest.category This element must be supported. This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.category.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
ServiceRequest.category.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
ServiceRequest.code.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
ServiceRequest.code.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.code.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
ServiceRequest.quantity[x] This element must be supported. This element is included in summaries. 0..1 Quantity Service amount
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(BePatient) Individual or Entity the service is ordered for
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. This element is included in summaries. 1..1 Reference(BePractitionerRole | BePractitioner) Who/what is requesting service
ServiceRequest.supportingInfo This element must be supported. 0..1 Reference(Resource) Additional clinical information
ServiceRequest.supportingInfo.reference This element must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

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.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.

Constraints

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()
mcn-2 error ServiceRequest If identifier is not present: supportingInfo and contained SHALL be present. identifier.empty() implies (supportingInfo.exists() and contained.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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: mcn-2
ServiceRequest.id This element must be supported. 1..1 id Logical id of this artifact
ServiceRequest.contained This element must be supported. 0..1 BeMyCareNetEagreementServiceRequestBinary Pure binary content defined by a format other than FHIR
ServiceRequest.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Fixed Value: active (no extensions allowed)
ServiceRequest.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Fixed Value: order (no extensions allowed)
ServiceRequest.category This element must be supported. 1..1 CodeableConcept Classification of service
ServiceRequest.category.coding 1..1 Coding Code defined by a terminology system
ServiceRequest.category.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.code 1..1 code Symbol in syntax defined by the system
ServiceRequest.code This element must be supported. 1..1 CodeableConcept What is being requested/ordered
ServiceRequest.code.coding 1..1 Coding Code defined by a terminology system
ServiceRequest.code.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.code.coding.code 1..1 code Symbol in syntax defined by the system
ServiceRequest.quantity[x] This element must be supported. 0..1 Quantity Service amount
ServiceRequest.subject This element must be supported. 1..1 Reference(BePatient) Individual or Entity the service is ordered for
ServiceRequest.authoredOn This element must be supported. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. 1..1 Reference(BePractitionerRole | BePractitioner) Who/what is requesting service
ServiceRequest.supportingInfo This element must be supported. 0..1 Reference(Resource) Additional clinical information
ServiceRequest.supportingInfo.reference This element must be supported. 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
mcn-2 error ServiceRequest If identifier is not present: supportingInfo and contained SHALL be present. identifier.empty() implies (supportingInfo.exists() and contained.exists())

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1, mcn-2
ServiceRequest.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ServiceRequest.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ServiceRequest.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
ServiceRequest.contained This element must be supported. 0..1 BeMyCareNetEagreementServiceRequestBinary Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well Pure binary content defined by a format other than FHIR
ServiceRequest.extension 0..* Extension Additional content defined by implementations
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.identifier This element is included in summaries. 0..* Identifier Identifiers assigned to this order
ServiceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
ServiceRequest.basedOn This element is included in summaries. 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
ServiceRequest.requisition This element is included in summaries. 0..1 Identifier Composite Request ID
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
Fixed Value: active (no extensions allowed)
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Fixed Value: order (no extensions allowed)
ServiceRequest.category This element must be supported. This element is included in summaries. 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
ServiceRequest.category.id 0..1 string Unique id for inter-element referencing
ServiceRequest.category.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.category.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
ServiceRequest.category.coding.id 0..1 string Unique id for inter-element referencing
ServiceRequest.category.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.category.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.category.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
ServiceRequest.category.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
ServiceRequest.category.coding.display This element is included in summaries. 0..1 string Representation defined by the system
ServiceRequest.category.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
ServiceRequest.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if service/procedure should not be performed
ServiceRequest.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
ServiceRequest.code.id 0..1 string Unique id for inter-element referencing
ServiceRequest.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.code.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
ServiceRequest.code.coding.id 0..1 string Unique id for inter-element referencing
ServiceRequest.code.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.code.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct (no extensions allowed)
ServiceRequest.code.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
ServiceRequest.code.coding.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
ServiceRequest.code.coding.display This element is included in summaries. 0..1 string Representation defined by the system
ServiceRequest.code.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
ServiceRequest.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
ServiceRequest.orderDetail This element is included in summaries. C 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
ServiceRequest.quantity[x] This element must be supported. This element is included in summaries. 0..1 Quantity Service amount
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(BePatient) Individual or Entity the service is ordered for
ServiceRequest.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter in which the request was created
ServiceRequest.occurrence[x] This element is included in summaries. 0..1 When service should occur
ServiceRequest.occurrence[x].occurrenceDateTime dateTime
ServiceRequest.occurrence[x].occurrencePeriod Period
ServiceRequest.occurrence[x].occurrenceTiming Timing
ServiceRequest.asNeeded[x] This element is included in summaries. 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.
ServiceRequest.asNeeded[x].asNeededBoolean boolean
ServiceRequest.asNeeded[x].asNeededCodeableConcept CodeableConcept
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. 1..1 dateTime Date request signed
ServiceRequest.requester This element must be supported. This element is included in summaries. 1..1 Reference(BePractitionerRole | BePractitioner) Who/what is requesting service
ServiceRequest.performerType This element is included in summaries. 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.
ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
ServiceRequest.locationCode This element is included in summaries. 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
ServiceRequest.locationReference This element is included in summaries. 0..* Reference(Location) Requested location
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
ServiceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
ServiceRequest.supportingInfo This element must be supported. 0..1 Reference(Resource) Additional clinical information
ServiceRequest.supportingInfo.id 0..1 string Unique id for inter-element referencing
ServiceRequest.supportingInfo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.supportingInfo.reference This element must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ServiceRequest.supportingInfo.type This element is included in summaries. 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).
ServiceRequest.supportingInfo.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
ServiceRequest.supportingInfo.display This element is included in summaries. 0..1 string Text alternative for the resource
ServiceRequest.specimen This element is included in summaries. 0..* Reference(Specimen) Procedure Samples
ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ServiceRequest.note 0..* Annotation Comments
ServiceRequest.patientInstruction This element is included in summaries. 0..1 string Patient or consumer-oriented instructions
ServiceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

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.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
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.5
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.

Constraints

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()
mcn-2 error ServiceRequest If identifier is not present: supportingInfo and contained SHALL be present. identifier.empty() implies (supportingInfo.exists() and contained.exists())
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

 

Other representations of profile: CSV, Excel, Schematron