Belgian MyCareNet Profiles
2.0.0 - STU
Belgian MyCareNet Profiles
2.0.0 - STU
This page is part of the HL7 Belgium FHIR Implementation Guide - MyCareNet profiles (v2.0.0: Trial Use) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). 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.0.0 | |||
| Active as of 2023-04-27 | Computable Name: BeMyCareNetEagreementServiceRequest | |||
The ServiceRequest profile for use in the different eAgreement flows from MyCareNet.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed mcn-1: If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. mcn-2: If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. |
  id | S | 1..1 | id | Logical id of this artifact |
 meta | S | 1..1 | Meta | Metadata about the resource |
  profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| contained | S | 0..1 | BeMyCareNetEagreementServiceRequestBinary | 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 | 0..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 | 0..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(Patient core BE profile) | Individual or Entity the service is ordered for |
| authoredOn | S | 0..1 | dateTime | Date request signed |
| requester | S | 0..1 | Reference(Practitioner role core BE profile | Practitioner core BE profile) | 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-1 | error | ServiceRequest | If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. : identifier.exists() implies (category.empty() and code.empty() and quantityQuantity.empty() and authoredOn.empty() and supportingInfo.empty() and contained.empty()) | |
| mcn-2 | error | ServiceRequest | If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. : identifier.empty() implies (category.exists() and code.exists() and quantityQuantity.exists() and authoredOn.exists() and supportingInfo.exists() and contained.exists()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed mcn-1: If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. mcn-2: If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. |
 id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | S | 0..1 | BeMyCareNetEagreementServiceRequestBinary | Pure binary content defined by a format other than FHIR |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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Σ | 0..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Σ | 0..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 and a valueset using LOINC Order codes is available here. |
| 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(Patient core BE profile) | Individual or Entity the service is ordered for |
| authoredOn | SΣ | 0..1 | dateTime | Date request signed |
| requester | SΣ | 0..1 | Reference(Practitioner role core BE profile | Practitioner core BE profile) | 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 |
| ServiceRequest.status | required | Fixed Value: active |
| ServiceRequest.intent | required | Fixed Value: order |
| ServiceRequest.category | example | ServiceRequestCategoryCodes |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
| 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 | **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-1 | error | ServiceRequest | If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. : identifier.exists() implies (category.empty() and code.empty() and quantityQuantity.empty() and authoredOn.empty() and supportingInfo.empty() and contained.empty()) | |
| mcn-2 | error | ServiceRequest | If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. : identifier.empty() implies (category.exists() and code.exists() and quantityQuantity.exists() and authoredOn.exists() and supportingInfo.exists() and contained.exists()) | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed mcn-1: If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. mcn-2: If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. | ||||
| id | SΣ | 1..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| contained | S | 0..1 | BeMyCareNetEagreementServiceRequestBinary | Pure binary content defined by a format other than FHIR | ||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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Σ | 0..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 | |||||
| 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 | |||||
| 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Σ | 0..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 and a valueset using LOINC Order codes is available here. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | |||||
| 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(Patient core BE profile) | 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Σ | 0..1 | dateTime | Date request signed | ||||
| requester | SΣ | 0..1 | Reference(Practitioner role core BE profile | Practitioner core BE profile) | Who/what is requesting service | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | 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 | |||||
| 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 | ||||
| ServiceRequest.meta.security | extensible | All Security Labels | ||||
| ServiceRequest.meta.tag | example | CommonTags | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.status | required | Fixed Value: active | ||||
| ServiceRequest.intent | required | Fixed Value: order | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
| ServiceRequest.priority | required | RequestPriority | ||||
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
| ServiceRequest.performerType | example | ParticipantRoles | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodes | ||||
| ServiceRequest.supportingInfo.type | extensible | ResourceType | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from ServiceRequest
Summary
Mandatory: 3 elements (7 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 4 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed mcn-1: If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. mcn-2: If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. |
| id | S | 1..1 | id | Logical id of this artifact |
| meta | S | 1..1 | Meta | Metadata about the resource |
| profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| contained | S | 0..1 | BeMyCareNetEagreementServiceRequestBinary | 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 | 0..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 | 0..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(Patient core BE profile) | Individual or Entity the service is ordered for |
| authoredOn | S | 0..1 | dateTime | Date request signed |
| requester | S | 0..1 | Reference(Practitioner role core BE profile | Practitioner core BE profile) | 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-1 | error | ServiceRequest | If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. : identifier.exists() implies (category.empty() and code.empty() and quantityQuantity.empty() and authoredOn.empty() and supportingInfo.empty() and contained.empty()) | |
| mcn-2 | error | ServiceRequest | If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. : identifier.empty() implies (category.exists() and code.exists() and quantityQuantity.exists() and authoredOn.exists() and supportingInfo.exists() and contained.exists()) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed mcn-1: If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. mcn-2: If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | S | 0..1 | BeMyCareNetEagreementServiceRequestBinary | Pure binary content defined by a format other than FHIR |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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Σ | 0..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Σ | 0..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 and a valueset using LOINC Order codes is available here. |
| 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(Patient core BE profile) | Individual or Entity the service is ordered for |
| authoredOn | SΣ | 0..1 | dateTime | Date request signed |
| requester | SΣ | 0..1 | Reference(Practitioner role core BE profile | Practitioner core BE profile) | 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 |
| ServiceRequest.status | required | Fixed Value: active |
| ServiceRequest.intent | required | Fixed Value: order |
| ServiceRequest.category | example | ServiceRequestCategoryCodes |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
| 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 | **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-1 | error | ServiceRequest | If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. : identifier.exists() implies (category.empty() and code.empty() and quantityQuantity.empty() and authoredOn.empty() and supportingInfo.empty() and contained.empty()) | |
| mcn-2 | error | ServiceRequest | If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. : identifier.empty() implies (category.exists() and code.exists() and quantityQuantity.exists() and authoredOn.exists() and supportingInfo.exists() and contained.exists()) | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed mcn-1: If identifier is present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL not be present. mcn-2: If identifier is not present: (category, code, quantityQuantity, supportingInfo, authoredOn and contained) SHALL be present. | ||||
| id | SΣ | 1..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| contained | S | 0..1 | BeMyCareNetEagreementServiceRequestBinary | Pure binary content defined by a format other than FHIR | ||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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Σ | 0..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 | |||||
| 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 | |||||
| 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Σ | 0..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 and a valueset using LOINC Order codes is available here. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | |||||
| 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(Patient core BE profile) | 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Σ | 0..1 | dateTime | Date request signed | ||||
| requester | SΣ | 0..1 | Reference(Practitioner role core BE profile | Practitioner core BE profile) | Who/what is requesting service | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | 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 | |||||
| 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 | ||||
| ServiceRequest.meta.security | extensible | All Security Labels | ||||
| ServiceRequest.meta.tag | example | CommonTags | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.status | required | Fixed Value: active | ||||
| ServiceRequest.intent | required | Fixed Value: order | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
| ServiceRequest.priority | required | RequestPriority | ||||
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
| ServiceRequest.performerType | example | ParticipantRoles | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodes | ||||
| ServiceRequest.supportingInfo.type | extensible | ResourceType | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from ServiceRequest
Summary
Mandatory: 3 elements (7 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 4 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ eHealth Platform. Package hl7.fhir.be.mycarenet#2.0.0 based on FHIR 4.0.1. Generated 2023-04-27
Links: Table of Contents |
QA Report
