HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - STU1
HL7 FHIR Implementation Guide: Rwanda HIV, published by Jembi Health Systems. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/openhie/Rwanda-HIV and changes regularly. See the Directory of published versions
Official URL: http://openhie.org/fhir/rwanda-hiv/StructureDefinition/HIV-lab-order | Version: 0.1.0 | |||
Active as of 2023-09-15 | Computable Name: HIVServiceRequest |
Represents the record of request for the HIV VL lab order.
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 | 0..* | ServiceRequest | A request for a service to be performed | |
Slices for identifier | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system | |
identifier:PLAC | 0..1 | Identifier | Identifiers assigned to this order | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC | |
display | 0..1 | string | Representation defined by the system Required Pattern: Placer Identifier | |
text | 0..1 | string | Plain text representation of the concept Required Pattern: HIV lab service request identifier | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/lab-order-identifier | |
value | S | 0..1 | string | The value that is unique |
intent | 1..1 | code | proposal | plan | directive | order + Required Pattern: order | |
code | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: HIV Test Types (required) | |
concept | ||||
text | 0..1 | string | Plain text representation of the concept Required Pattern: Test Type | |
encounter | 1..1 | Reference(Encounter) | Encounter in which the request was created | |
Slices for occurrence[x] | 0..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this | |
occurrence[x]:occurrenceDateTime | S | 0..1 | dateTime | When service should occur |
requester | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |
performer | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |
reason | 1..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) | Explanation/Justification for procedure or service | |
specimen | 1..1 | Reference(Specimen) | Procedure Samples | |
note | S | 0..* | Annotation | Comments |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.code | required | VSTestTypes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
identifier:PLAC | Σ | 0..1 | Identifier | Identifiers assigned to this order |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/lab-order-identifier |
value | SΣC | 0..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
code | ΣC | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: HIV Test Types (required) |
subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
encounter | Σ | 1..1 | Reference(Encounter) | Encounter in which the request was created |
Slices for occurrence[x] | Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
occurrence[x]:occurrenceDateTime | SΣ | 0..1 | dateTime | When service should occur |
requester | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
performer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
reason | Σ | 1..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes |
specimen | Σ | 1..1 | Reference(Specimen) | Procedure Samples |
note | S | 0..* | Annotation | Comments |
Documentation for this format |
Path | Conformance | ValueSet / Code |
ServiceRequest.identifier:PLAC.use | required | IdentifierUse |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | Pattern: order |
ServiceRequest.code | required | VSTestTypes |
ServiceRequest.reason | example | ProcedureReasonCodes |
Id | Grade | Path(s) | Details | Requirements |
bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present : bodySite.exists() implies bodyStructure.empty() | |
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
identifier:PLAC | Σ | 0..1 | Identifier | Identifiers assigned to this order |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC |
display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Placer Identifier |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: HIV lab service request identifier |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/lab-order-identifier |
value | SΣC | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills |
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces |
requisition | Σ | 0..1 | Identifier | Composite Request ID |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order |
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
code | ΣC | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: HIV Test Types (required) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Test Type |
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) |
orderDetail | ΣC | 0..* | BackboneElement | Additional order information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
parameterFocus | 0..1 | CodeableReference(Device | DeviceDefinition | DeviceRequest | SupplyRequest | Medication | MedicationRequest | BiologicallyDerivedProduct | Substance) | The context of the order details by reference | |
parameter | Σ | 1..* | BackboneElement | The parameter details for the service being requested |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. |
value[x] | Σ | 1..1 | The value for the order detail | |
valueQuantity | Quantity | |||
valueRatio | Ratio | |||
valueRange | Range | |||
valueBoolean | boolean | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valuePeriod | Period | |||
quantity[x] | Σ | 0..1 | Service amount | |
quantityQuantity | Quantity | |||
quantityRatio | Ratio | |||
quantityRange | Range | |||
subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
focus | Σ | 0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record |
encounter | Σ | 1..1 | Reference(Encounter) | Encounter in which the request was created |
Slices for occurrence[x] | Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
occurrence[x]:occurrenceDateTime | SΣ | 0..1 | dateTime | When service should occur |
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
authoredOn | Σ | 0..1 | dateTime | Date request signed |
requester | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
performer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
location | Σ | 0..* | CodeableReference(Location) | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. |
reason | Σ | 1..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
supportingInfo | 0..* | CodeableReference(Resource) | Additional clinical information | |
specimen | Σ | 1..1 | Reference(Specimen) | Procedure Samples |
bodySite | ΣC | 0..* | CodeableConcept | Coded location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
bodyStructure | ΣC | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body |
note | S | 0..* | Annotation | Comments |
patientInstruction | 0..* | BackboneElement | Patient or consumer-oriented instructions | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
instruction[x] | Σ | 0..1 | Patient or consumer-oriented instructions | |
instructionMarkdown | markdown | |||
instructionReference | Reference(DocumentReference) | |||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
ServiceRequest.language | required | AllLanguages |
ServiceRequest.identifier:PLAC.use | required | IdentifierUse |
ServiceRequest.identifier:PLAC.type | extensible | IdentifierTypeCodes |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | Pattern: order |
ServiceRequest.category | example | ServiceRequestCategoryCodes |
ServiceRequest.priority | required | RequestPriority |
ServiceRequest.code | required | VSTestTypes |
ServiceRequest.orderDetail.parameter.code | example | ServiceRequestOrderDetailParameterCode |
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes |
ServiceRequest.performerType | example | ParticipantRoles |
ServiceRequest.location | example | ServiceDeliveryLocationRoleType |
ServiceRequest.reason | example | ProcedureReasonCodes |
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
Id | Grade | Path(s) | Details | Requirements |
bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present : bodySite.exists() implies bodyStructure.empty() | |
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from ServiceRequest
Summary
Mandatory: 7 elements (1 nested mandatory element)
Must-Support: 3 elements
Fixed Value: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ServiceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
Slices for identifier | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system | |
identifier:PLAC | 0..1 | Identifier | Identifiers assigned to this order | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC | |
display | 0..1 | string | Representation defined by the system Required Pattern: Placer Identifier | |
text | 0..1 | string | Plain text representation of the concept Required Pattern: HIV lab service request identifier | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/lab-order-identifier | |
value | S | 0..1 | string | The value that is unique |
intent | 1..1 | code | proposal | plan | directive | order + Required Pattern: order | |
code | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: HIV Test Types (required) | |
concept | ||||
text | 0..1 | string | Plain text representation of the concept Required Pattern: Test Type | |
encounter | 1..1 | Reference(Encounter) | Encounter in which the request was created | |
Slices for occurrence[x] | 0..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this | |
occurrence[x]:occurrenceDateTime | S | 0..1 | dateTime | When service should occur |
requester | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | |
performer | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | |
reason | 1..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) | Explanation/Justification for procedure or service | |
specimen | 1..1 | Reference(Specimen) | Procedure Samples | |
note | S | 0..* | Annotation | Comments |
Documentation for this format |
Path | Conformance | ValueSet |
ServiceRequest.code | required | VSTestTypes |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
identifier:PLAC | Σ | 0..1 | Identifier | Identifiers assigned to this order |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/lab-order-identifier |
value | SΣC | 0..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
code | ΣC | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: HIV Test Types (required) |
subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
encounter | Σ | 1..1 | Reference(Encounter) | Encounter in which the request was created |
Slices for occurrence[x] | Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
occurrence[x]:occurrenceDateTime | SΣ | 0..1 | dateTime | When service should occur |
requester | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
performer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
reason | Σ | 1..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes |
specimen | Σ | 1..1 | Reference(Specimen) | Procedure Samples |
note | S | 0..* | Annotation | Comments |
Documentation for this format |
Path | Conformance | ValueSet / Code |
ServiceRequest.identifier:PLAC.use | required | IdentifierUse |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | Pattern: order |
ServiceRequest.code | required | VSTestTypes |
ServiceRequest.reason | example | ProcedureReasonCodes |
Id | Grade | Path(s) | Details | Requirements |
bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present : bodySite.exists() implies bodyStructure.empty() | |
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
identifier:PLAC | Σ | 0..1 | Identifier | Identifiers assigned to this order |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC |
display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Placer Identifier |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: HIV lab service request identifier |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://openhie.org/fhir/rwanda-hiv/identifier/lab-order-identifier |
value | SΣC | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills |
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces |
requisition | Σ | 0..1 | Identifier | Composite Request ID |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order |
category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
code | ΣC | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: HIV Test Types (required) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Test Type |
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) |
orderDetail | ΣC | 0..* | BackboneElement | Additional order information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
parameterFocus | 0..1 | CodeableReference(Device | DeviceDefinition | DeviceRequest | SupplyRequest | Medication | MedicationRequest | BiologicallyDerivedProduct | Substance) | The context of the order details by reference | |
parameter | Σ | 1..* | BackboneElement | The parameter details for the service being requested |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. |
value[x] | Σ | 1..1 | The value for the order detail | |
valueQuantity | Quantity | |||
valueRatio | Ratio | |||
valueRange | Range | |||
valueBoolean | boolean | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valuePeriod | Period | |||
quantity[x] | Σ | 0..1 | Service amount | |
quantityQuantity | Quantity | |||
quantityRatio | Ratio | |||
quantityRange | Range | |||
subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
focus | Σ | 0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record |
encounter | Σ | 1..1 | Reference(Encounter) | Encounter in which the request was created |
Slices for occurrence[x] | Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
occurrence[x]:occurrenceDateTime | SΣ | 0..1 | dateTime | When service should occur |
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
authoredOn | Σ | 0..1 | dateTime | Date request signed |
requester | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
performer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
location | Σ | 0..* | CodeableReference(Location) | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. |
reason | Σ | 1..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
supportingInfo | 0..* | CodeableReference(Resource) | Additional clinical information | |
specimen | Σ | 1..1 | Reference(Specimen) | Procedure Samples |
bodySite | ΣC | 0..* | CodeableConcept | Coded location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
bodyStructure | ΣC | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body |
note | S | 0..* | Annotation | Comments |
patientInstruction | 0..* | BackboneElement | Patient or consumer-oriented instructions | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
instruction[x] | Σ | 0..1 | Patient or consumer-oriented instructions | |
instructionMarkdown | markdown | |||
instructionReference | Reference(DocumentReference) | |||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
ServiceRequest.language | required | AllLanguages |
ServiceRequest.identifier:PLAC.use | required | IdentifierUse |
ServiceRequest.identifier:PLAC.type | extensible | IdentifierTypeCodes |
ServiceRequest.status | required | RequestStatus |
ServiceRequest.intent | required | Pattern: order |
ServiceRequest.category | example | ServiceRequestCategoryCodes |
ServiceRequest.priority | required | RequestPriority |
ServiceRequest.code | required | VSTestTypes |
ServiceRequest.orderDetail.parameter.code | example | ServiceRequestOrderDetailParameterCode |
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes |
ServiceRequest.performerType | example | ParticipantRoles |
ServiceRequest.location | example | ServiceDeliveryLocationRoleType |
ServiceRequest.reason | example | ProcedureReasonCodes |
ServiceRequest.bodySite | example | SNOMEDCTBodyStructures |
Id | Grade | Path(s) | Details | Requirements |
bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present : bodySite.exists() implies bodyStructure.empty() | |
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from ServiceRequest
Summary
Mandatory: 7 elements (1 nested mandatory element)
Must-Support: 3 elements
Fixed Value: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron