Belgian MyCareNet Profiles
2.1.1 - STU
Belgian MyCareNet Profiles
2.1.1 - STU
This page is part of the HL7 Belgium FHIR Implementation Guide - MyCareNet profiles (v2.1.1: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.1.2. For a full list of available versions, see the Directory of published versions
| Official URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-eagreementservicerequest | Version: 2.1.1 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: BeMyCareNetEagreementServiceRequest | ||
The ServiceRequest profile for use in the different eAgreement flows from MyCareNet.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | ServiceRequest(4.0.1) | A request for a service to be performed Constraints: prr-1, mcn-2 |
  id |
SΣ | 1..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
S | 0..1 | BeMyCareNetEagreementServiceRequestBinary(2.1.1) | Pure binary content defined by a format other than FHIR |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!SΣ | 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 |
| intent |
?!SΣ | 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 |
  category |
SΣ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
  coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
 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 |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 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. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| 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 |
| quantity[x] |
SΣ | 0..1 | Quantity | Service amount |
 subject |
SΣ | 1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for |
| authoredOn |
SΣ | 1..1 | dateTime | Date request signed |
| requester |
SΣ | 1..1 | Reference(BePractitionerRole(2.1.2) | BePractitioner(2.1.2)) | Who/what is requesting service |
| supportingInfo |
S | 0..1 | Reference(Resource) | Additional clinical information |
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category|4.0.1From the FHIR Standard | |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | ServiceRequest.implicitRules, ServiceRequest.modifierExtension, ServiceRequest.status, ServiceRequest.intent, ServiceRequest.category, ServiceRequest.category.coding, ServiceRequest.category.coding.system, ServiceRequest.category.coding.code, ServiceRequest.doNotPerform, ServiceRequest.code, ServiceRequest.code.coding, ServiceRequest.code.coding.system, ServiceRequest.code.coding.code, ServiceRequest.quantity[x], ServiceRequest.subject, ServiceRequest.authoredOn, ServiceRequest.requester, ServiceRequest.supportingInfo, ServiceRequest.supportingInfo.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ServiceRequest.modifierExtension | 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest(4.0.1) | A request for a service to be performed |
 id |
S | 1..1 | id | Logical id of this artifact |
| contained |
S | 0..1 | BeMyCareNetEagreementServiceRequestBinary(2.1.1) | Pure binary content defined by a format other than FHIR |
| status |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Fixed Value: active |
| intent |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order |
| category |
S | 1..1 | CodeableConcept | Classification of service |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| 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 | |
| code |
S | 1..1 | CodeableConcept | What is being requested/ordered |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| 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 | |
| quantity[x] |
S | 0..1 | Quantity | Service amount |
| subject |
S | 1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for |
| authoredOn |
S | 1..1 | dateTime | Date request signed |
| requester |
S | 1..1 | Reference(BePractitionerRole(2.1.2) | BePractitioner(2.1.2)) | Who/what is requesting service |
| supportingInfo |
S | 0..1 | Reference(Resource) | Additional clinical information |
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| mcn-2 | error | ServiceRequest | If identifier is not present: supportingInfo and contained SHALL be present. : identifier.empty() implies (supportingInfo.exists() and contained.exists()) |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest(4.0.1) | A request for a service to be performed Constraints: prr-1, mcn-2 | ||||
| id |
SΣ | 1..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
S | 0..1 | BeMyCareNetEagreementServiceRequestBinary(2.1.1) | Pure binary content defined by a format other than FHIR | ||||
 extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 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 | ||||
| intent |
?!SΣ | 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 | ||||
| category |
SΣ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| 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 | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 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. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| 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 | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
SΣ | 0..1 | Quantity | Service amount | ||||
| subject |
SΣ | 1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
 occurrence[x] |
Σ | 0..1 | When service should occur | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
SΣ | 1..1 | dateTime | Date request signed | ||||
| requester |
SΣ | 1..1 | Reference(BePractitionerRole(2.1.2) | BePractitioner(2.1.2)) | Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
S | 0..1 | Reference(Resource) | Additional clinical information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| ServiceRequest.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | ||||
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category|4.0.1From the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | ||||
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code|4.0.1From the FHIR Standard | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail|4.0.1From the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1From the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role|4.0.1From the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType|3.0.0 | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason|4.0.1From the FHIR Standard | ||||
| ServiceRequest.supportingInfo.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | ServiceRequest.meta, ServiceRequest.implicitRules, ServiceRequest.language, ServiceRequest.text, ServiceRequest.extension, ServiceRequest.modifierExtension, ServiceRequest.identifier, ServiceRequest.instantiatesCanonical, ServiceRequest.instantiatesUri, ServiceRequest.basedOn, ServiceRequest.replaces, ServiceRequest.requisition, ServiceRequest.status, ServiceRequest.intent, ServiceRequest.category, ServiceRequest.category.extension, ServiceRequest.category.coding, ServiceRequest.category.coding.extension, ServiceRequest.category.coding.system, ServiceRequest.category.coding.version, ServiceRequest.category.coding.code, ServiceRequest.category.coding.display, ServiceRequest.category.coding.userSelected, ServiceRequest.category.text, ServiceRequest.priority, ServiceRequest.doNotPerform, ServiceRequest.code, ServiceRequest.code.extension, ServiceRequest.code.coding, ServiceRequest.code.coding.extension, ServiceRequest.code.coding.system, ServiceRequest.code.coding.version, ServiceRequest.code.coding.code, ServiceRequest.code.coding.display, ServiceRequest.code.coding.userSelected, ServiceRequest.code.text, ServiceRequest.orderDetail, ServiceRequest.quantity[x], ServiceRequest.subject, ServiceRequest.encounter, ServiceRequest.occurrence[x], ServiceRequest.asNeeded[x], ServiceRequest.authoredOn, ServiceRequest.requester, ServiceRequest.performerType, ServiceRequest.performer, ServiceRequest.locationCode, ServiceRequest.locationReference, ServiceRequest.reasonCode, ServiceRequest.reasonReference, ServiceRequest.insurance, ServiceRequest.supportingInfo, ServiceRequest.supportingInfo.extension, ServiceRequest.supportingInfo.reference, ServiceRequest.supportingInfo.type, ServiceRequest.supportingInfo.identifier, ServiceRequest.supportingInfo.display, ServiceRequest.specimen, ServiceRequest.bodySite, ServiceRequest.note, ServiceRequest.patientInstruction, ServiceRequest.relevantHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ServiceRequest.extension, ServiceRequest.modifierExtension, ServiceRequest.category.extension, ServiceRequest.category.coding.extension, ServiceRequest.code.extension, ServiceRequest.code.coding.extension, ServiceRequest.supportingInfo.extension | 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
Summary
Mandatory: 11 elements(1 nested mandatory element)
Must-Support: 12 elements
Fixed: 4 elements
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest(4.0.1) | A request for a service to be performed Constraints: prr-1, mcn-2 |
| id |
SΣ | 1..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
S | 0..1 | BeMyCareNetEagreementServiceRequestBinary(2.1.1) | Pure binary content defined by a format other than FHIR |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!SΣ | 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 |
| intent |
?!SΣ | 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 |
| category |
SΣ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| 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 |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 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. |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| 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 |
| quantity[x] |
SΣ | 0..1 | Quantity | Service amount |
| subject |
SΣ | 1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for |
| authoredOn |
SΣ | 1..1 | dateTime | Date request signed |
| requester |
SΣ | 1..1 | Reference(BePractitionerRole(2.1.2) | BePractitioner(2.1.2)) | Who/what is requesting service |
| supportingInfo |
S | 0..1 | Reference(Resource) | Additional clinical information |
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category|4.0.1From the FHIR Standard | |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | ServiceRequest.implicitRules, ServiceRequest.modifierExtension, ServiceRequest.status, ServiceRequest.intent, ServiceRequest.category, ServiceRequest.category.coding, ServiceRequest.category.coding.system, ServiceRequest.category.coding.code, ServiceRequest.doNotPerform, ServiceRequest.code, ServiceRequest.code.coding, ServiceRequest.code.coding.system, ServiceRequest.code.coding.code, ServiceRequest.quantity[x], ServiceRequest.subject, ServiceRequest.authoredOn, ServiceRequest.requester, ServiceRequest.supportingInfo, ServiceRequest.supportingInfo.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ServiceRequest.modifierExtension | 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest(4.0.1) | A request for a service to be performed |
| id |
S | 1..1 | id | Logical id of this artifact |
| contained |
S | 0..1 | BeMyCareNetEagreementServiceRequestBinary(2.1.1) | Pure binary content defined by a format other than FHIR |
| status |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Fixed Value: active |
| intent |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order |
| category |
S | 1..1 | CodeableConcept | Classification of service |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| 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 | |
| code |
S | 1..1 | CodeableConcept | What is being requested/ordered |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| 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 | |
| quantity[x] |
S | 0..1 | Quantity | Service amount |
| subject |
S | 1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for |
| authoredOn |
S | 1..1 | dateTime | Date request signed |
| requester |
S | 1..1 | Reference(BePractitionerRole(2.1.2) | BePractitioner(2.1.2)) | Who/what is requesting service |
| supportingInfo |
S | 0..1 | Reference(Resource) | Additional clinical information |
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| mcn-2 | error | ServiceRequest | If identifier is not present: supportingInfo and contained SHALL be present. : identifier.empty() implies (supportingInfo.exists() and contained.exists()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest(4.0.1) | A request for a service to be performed Constraints: prr-1, mcn-2 | ||||
| id |
SΣ | 1..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
S | 0..1 | BeMyCareNetEagreementServiceRequestBinary(2.1.1) | Pure binary content defined by a format other than FHIR | ||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 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 | ||||
| intent |
?!SΣ | 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 | ||||
| category |
SΣ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| 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 | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 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. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| 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 | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
SΣ | 0..1 | Quantity | Service amount | ||||
| subject |
SΣ | 1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| occurrence[x] |
Σ | 0..1 | When service should occur | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
SΣ | 1..1 | dateTime | Date request signed | ||||
| requester |
SΣ | 1..1 | Reference(BePractitionerRole(2.1.2) | BePractitioner(2.1.2)) | Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
S | 0..1 | Reference(Resource) | Additional clinical information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| ServiceRequest.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | ||||
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category|4.0.1From the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | ||||
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code|4.0.1From the FHIR Standard | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail|4.0.1From the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1From the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role|4.0.1From the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType|3.0.0 | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason|4.0.1From the FHIR Standard | ||||
| ServiceRequest.supportingInfo.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | ServiceRequest.meta, ServiceRequest.implicitRules, ServiceRequest.language, ServiceRequest.text, ServiceRequest.extension, ServiceRequest.modifierExtension, ServiceRequest.identifier, ServiceRequest.instantiatesCanonical, ServiceRequest.instantiatesUri, ServiceRequest.basedOn, ServiceRequest.replaces, ServiceRequest.requisition, ServiceRequest.status, ServiceRequest.intent, ServiceRequest.category, ServiceRequest.category.extension, ServiceRequest.category.coding, ServiceRequest.category.coding.extension, ServiceRequest.category.coding.system, ServiceRequest.category.coding.version, ServiceRequest.category.coding.code, ServiceRequest.category.coding.display, ServiceRequest.category.coding.userSelected, ServiceRequest.category.text, ServiceRequest.priority, ServiceRequest.doNotPerform, ServiceRequest.code, ServiceRequest.code.extension, ServiceRequest.code.coding, ServiceRequest.code.coding.extension, ServiceRequest.code.coding.system, ServiceRequest.code.coding.version, ServiceRequest.code.coding.code, ServiceRequest.code.coding.display, ServiceRequest.code.coding.userSelected, ServiceRequest.code.text, ServiceRequest.orderDetail, ServiceRequest.quantity[x], ServiceRequest.subject, ServiceRequest.encounter, ServiceRequest.occurrence[x], ServiceRequest.asNeeded[x], ServiceRequest.authoredOn, ServiceRequest.requester, ServiceRequest.performerType, ServiceRequest.performer, ServiceRequest.locationCode, ServiceRequest.locationReference, ServiceRequest.reasonCode, ServiceRequest.reasonReference, ServiceRequest.insurance, ServiceRequest.supportingInfo, ServiceRequest.supportingInfo.extension, ServiceRequest.supportingInfo.reference, ServiceRequest.supportingInfo.type, ServiceRequest.supportingInfo.identifier, ServiceRequest.supportingInfo.display, ServiceRequest.specimen, ServiceRequest.bodySite, ServiceRequest.note, ServiceRequest.patientInstruction, ServiceRequest.relevantHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ServiceRequest.extension, ServiceRequest.modifierExtension, ServiceRequest.category.extension, ServiceRequest.category.coding.extension, ServiceRequest.code.extension, ServiceRequest.code.coding.extension, ServiceRequest.supportingInfo.extension | 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
Summary
Mandatory: 11 elements(1 nested mandatory element)
Must-Support: 12 elements
Fixed: 4 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ eHealth Platform. Package hl7.fhir.be.mycarenet#2.1.1 based on FHIR 4.0.1. Generated 2025-06-25
Links: Table of Contents |
QA Report
