CH LAB-Order (R4)
2.0.0-ballot - ballot
CH LAB-Order (R4)
2.0.0-ballot - ballot
This page is part of the CH LAB-Order (R4) (v2.0.0-ballot: STU 2 Ballot 1) 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: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-order-SR-singletest | Version: 2.0.0-ballot | |||
| Draft as of 2019-02-05 | Computable Name: ChLabOrderSRSingletest | |||
Copyright/Legal: CC0-1.0 |
||||
Definition of a ServiceRequests of a single LabTest in the context of CH LAB-Order
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ChOrfServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | 0..* | ChOrfServiceRequest | CH LAB-Order ServiceRequest for a labtest | |
  instantiatesCanonical | S | 1..1 | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
 basedOn | 0..* | Reference(CH LAB-Order-SR Labtest) | What request fulfills | |
| requisition | S | 1..1 | Identifier | Composite Request ID |
| code | 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. | |
 reasonCode | S | 0..* | CodeableConcept | Clinical Question in free text |
  text | S | 1..1 | string | Plain text representation of the concept |
| reasonReference | S | 0..* | Reference(CH LAB-Order Diagnosis Condition) | Reason for the referral (primary diagnosis) |
| specimen | 0..* | Reference(Specimen) | Must be present, if order category is #RequestForLabExam or #RequestForHistopathExam | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ChOrfServiceRequest | CH LAB-Order ServiceRequest for a labtest |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 locationAndTime | S | 0..* | Reference(CH ORF Appointment) | CH ORF Location and Time URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-locationandtime |
| requestedEncounterDetails | S | 0..1 | Reference(CH ORF Requested Encounter) | CH ORF Requested Encounter Details URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-requestedencounterdetails |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier | SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by pattern:$this |
 identifier:placerOrderIdentifier | SΣ | 1..1 | Identifier | Placer Order Identifier Required Pattern: At least the following |
   type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
 use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
 value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
 identifier:fillerOrderIdentifier | SΣ | 0..1 | Identifier | Filler Order Identifier Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| instantiatesCanonical | SΣ | 1..1 | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
| basedOn | Σ | 0..* | Reference(CH LAB-Order-SR Labtest) | What request fulfills |
 requisition | SΣ | 1..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. |
| 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. |
| priority | SΣ | 0..1 | code | Order priority 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 | Σ | 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. |
| subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient |
| requester | SΣ | 0..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content |
| reasonCode | SΣ | 0..* | CodeableConcept | Clinical Question in free text Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| reasonReference | SΣ | 0..* | Reference(CH LAB-Order Diagnosis Condition) | Reason for the referral (primary diagnosis) |
| insurance | S | 0..* | Reference(CH ORF Coverage) | Associated insurance coverage |
| specimen | Σ | 0..* | Reference(Specimen) | Must be present, if order category is #RequestForLabExam or #RequestForHistopathExam |
| note | S | 0..* | Annotation | Comments |
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.identifier:placerOrderIdentifier.use | required | IdentifierUse |
| ServiceRequest.identifier:fillerOrderIdentifier.use | required | IdentifierUse |
| ServiceRequest.status | required | RequestStatus |
| ServiceRequest.intent | required | RequestIntent |
| ServiceRequest.priority | required | RequestPriority |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
| ServiceRequest.reasonCode | example | ProcedureReasonCodes |
| 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() | |
| 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..* | ChOrfServiceRequest | CH LAB-Order ServiceRequest for a labtest | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| locationAndTime | S | 0..* | Reference(CH ORF Appointment) | CH ORF Location and Time URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-locationandtime | ||||
| requestedEncounterDetails | S | 0..1 | Reference(CH ORF Requested Encounter) | CH ORF Requested Encounter Details URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-requestedencounterdetails | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by pattern:$this | ||||
| identifier:placerOrderIdentifier | SΣ | 1..1 | Identifier | Placer Order Identifier Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
| display | 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 | |||||
| system | 0..1 | uri | The namespace for the identifier value | |||||
| value | 0..1 | string | The value that is unique | |||||
| 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) | |||||
| id | 0..1 | string | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:fillerOrderIdentifier | SΣ | 0..1 | Identifier | Filler Order Identifier Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||
| display | 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 | |||||
| system | 0..1 | uri | The namespace for the identifier value | |||||
| value | 0..1 | string | The value that is unique | |||||
| 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) | |||||
| id | 0..1 | string | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| instantiatesCanonical | SΣ | 1..1 | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn | Σ | 0..* | Reference(CH LAB-Order-SR Labtest) | What request fulfills | ||||
| replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition | SΣ | 1..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. | ||||
| 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. | ||||
| category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority | SΣ | 0..1 | code | Order priority 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 | Σ | 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. | ||||
| orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
 quantity[x] | Σ | 0..1 | Service amount | |||||
| quantityQuantity | Quantity | |||||||
| quantityRatio | Ratio | |||||||
| quantityRange | Range | |||||||
| subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient | ||||
| 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 | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | SΣ | 0..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content | ||||
| 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 | SΣ | 0..* | CodeableConcept | Clinical Question in free text Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| 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 | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
| reasonReference | SΣ | 0..* | Reference(CH LAB-Order Diagnosis Condition) | Reason for the referral (primary diagnosis) | ||||
| insurance | S | 0..* | Reference(CH ORF Coverage) | Associated insurance coverage | ||||
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
| specimen | Σ | 0..* | Reference(Specimen) | Must be present, if order category is #RequestForLabExam or #RequestForHistopathExam | ||||
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note | S | 0..* | Annotation | Comments | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| patientInstruction | Σ | 0..1 | string | Use Appointment.patientInstruction (referenced via ServiceRequest.extension) for patient-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.identifier:placerOrderIdentifier.use | required | IdentifierUse | ||||
| ServiceRequest.identifier:placerOrderIdentifier.type | extensible | Identifier Type Codes | ||||
| ServiceRequest.identifier:fillerOrderIdentifier.use | required | IdentifierUse | ||||
| ServiceRequest.identifier:fillerOrderIdentifier.type | extensible | Identifier Type Codes | ||||
| ServiceRequest.status | required | RequestStatus | ||||
| ServiceRequest.intent | required | RequestIntent | ||||
| 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.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 ChOrfServiceRequest
Differential View
This structure is derived from ChOrfServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | 0..* | ChOrfServiceRequest | CH LAB-Order ServiceRequest for a labtest | |
| instantiatesCanonical | S | 1..1 | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
| basedOn | 0..* | Reference(CH LAB-Order-SR Labtest) | What request fulfills | |
| requisition | S | 1..1 | Identifier | Composite Request ID |
| code | 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. | |
| reasonCode | S | 0..* | CodeableConcept | Clinical Question in free text |
| text | S | 1..1 | string | Plain text representation of the concept |
| reasonReference | S | 0..* | Reference(CH LAB-Order Diagnosis Condition) | Reason for the referral (primary diagnosis) |
| specimen | 0..* | Reference(Specimen) | Must be present, if order category is #RequestForLabExam or #RequestForHistopathExam | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ChOrfServiceRequest | CH LAB-Order ServiceRequest for a labtest |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| locationAndTime | S | 0..* | Reference(CH ORF Appointment) | CH ORF Location and Time URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-locationandtime |
| requestedEncounterDetails | S | 0..1 | Reference(CH ORF Requested Encounter) | CH ORF Requested Encounter Details URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-requestedencounterdetails |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by pattern:$this |
| identifier:placerOrderIdentifier | SΣ | 1..1 | Identifier | Placer Order Identifier Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:fillerOrderIdentifier | SΣ | 0..1 | Identifier | Filler Order Identifier Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| instantiatesCanonical | SΣ | 1..1 | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
| basedOn | Σ | 0..* | Reference(CH LAB-Order-SR Labtest) | What request fulfills |
| requisition | SΣ | 1..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. |
| 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. |
| priority | SΣ | 0..1 | code | Order priority 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 | Σ | 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. |
| subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient |
| requester | SΣ | 0..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content |
| reasonCode | SΣ | 0..* | CodeableConcept | Clinical Question in free text Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| reasonReference | SΣ | 0..* | Reference(CH LAB-Order Diagnosis Condition) | Reason for the referral (primary diagnosis) |
| insurance | S | 0..* | Reference(CH ORF Coverage) | Associated insurance coverage |
| specimen | Σ | 0..* | Reference(Specimen) | Must be present, if order category is #RequestForLabExam or #RequestForHistopathExam |
| note | S | 0..* | Annotation | Comments |
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.identifier:placerOrderIdentifier.use | required | IdentifierUse |
| ServiceRequest.identifier:fillerOrderIdentifier.use | required | IdentifierUse |
| ServiceRequest.status | required | RequestStatus |
| ServiceRequest.intent | required | RequestIntent |
| ServiceRequest.priority | required | RequestPriority |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT) |
| ServiceRequest.reasonCode | example | ProcedureReasonCodes |
| 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() | |
| 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..* | ChOrfServiceRequest | CH LAB-Order ServiceRequest for a labtest | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| locationAndTime | S | 0..* | Reference(CH ORF Appointment) | CH ORF Location and Time URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-locationandtime | ||||
| requestedEncounterDetails | S | 0..1 | Reference(CH ORF Requested Encounter) | CH ORF Requested Encounter Details URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-requestedencounterdetails | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by pattern:$this | ||||
| identifier:placerOrderIdentifier | SΣ | 1..1 | Identifier | Placer Order Identifier Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
| display | 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 | |||||
| system | 0..1 | uri | The namespace for the identifier value | |||||
| value | 0..1 | string | The value that is unique | |||||
| 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) | |||||
| id | 0..1 | string | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:fillerOrderIdentifier | SΣ | 0..1 | Identifier | Filler Order Identifier Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||
| display | 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 | |||||
| system | 0..1 | uri | The namespace for the identifier value | |||||
| value | 0..1 | string | The value that is unique | |||||
| 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) | |||||
| id | 0..1 | string | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| instantiatesCanonical | SΣ | 1..1 | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn | Σ | 0..* | Reference(CH LAB-Order-SR Labtest) | What request fulfills | ||||
| replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition | SΣ | 1..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. | ||||
| 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. | ||||
| category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority | SΣ | 0..1 | code | Order priority 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 | Σ | 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. | ||||
| orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] | Σ | 0..1 | Service amount | |||||
| quantityQuantity | Quantity | |||||||
| quantityRatio | Ratio | |||||||
| quantityRange | Range | |||||||
| subject | SΣ | 1..1 | Reference(CH Core Patient) | Patient | ||||
| 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 | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | SΣ | 0..1 | Reference(CH Core PractitionerRole) | The person/organization responsible for the form content | ||||
| 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 | SΣ | 0..* | CodeableConcept | Clinical Question in free text Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| 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 | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
| reasonReference | SΣ | 0..* | Reference(CH LAB-Order Diagnosis Condition) | Reason for the referral (primary diagnosis) | ||||
| insurance | S | 0..* | Reference(CH ORF Coverage) | Associated insurance coverage | ||||
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
| specimen | Σ | 0..* | Reference(Specimen) | Must be present, if order category is #RequestForLabExam or #RequestForHistopathExam | ||||
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note | S | 0..* | Annotation | Comments | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| patientInstruction | Σ | 0..1 | string | Use Appointment.patientInstruction (referenced via ServiceRequest.extension) for patient-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.identifier:placerOrderIdentifier.use | required | IdentifierUse | ||||
| ServiceRequest.identifier:placerOrderIdentifier.type | extensible | Identifier Type Codes | ||||
| ServiceRequest.identifier:fillerOrderIdentifier.use | required | IdentifierUse | ||||
| ServiceRequest.identifier:fillerOrderIdentifier.type | extensible | Identifier Type Codes | ||||
| ServiceRequest.status | required | RequestStatus | ||||
| ServiceRequest.intent | required | RequestIntent | ||||
| 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.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 ChOrfServiceRequest
Other representations of profile: CSV, Excel, Schematron