Structured Data Capture
4.0.0-ballot - STU 4 ballot
Structured Data Capture
4.0.0-ballot - STU 4 ballot
Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-servicerequest | Version: 4.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: SDCQuestionnaireServiceRequest | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.67 | ||||
Defines how ServiceRequest is used to ask for a Questionnaire to be completed
This profile inherits from the base ServiceRequest. It identifies core elements and extensions that must be supported and highlights other elements that, while not required, is used to ask for a Questionnaire to be completed.
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 extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   questionnaire |
1..* | canonical(Questionnaire) | Questionnaire to be completed URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-servicerequest-questionnaire | |
  status |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
| intent |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed Fixed Value: false | |
| code |
S | 1..1 | CodeableConcept | What is being requested/ordered Required Pattern: At least the following |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: complete-questionnaire | |
| subject |
S | 1..1 | Reference(Patient | Group | Location | Device) | Patient or other Questionnaire is for |
| occurrence[x] |
S | 0..1 | dateTime, Period, Timing | When (and possibly how often) the Questionnaire needs to be completed |
| requester |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| performer |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Who should complete questionnaire |
| reasonCode |
S | 0..* | CodeableConcept | Explanation/Justification for procedure or service |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| questionnaire |
1..* | canonical(Questionnaire) | Questionnaire to be completed URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-servicerequest-questionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children Fixed Value: false |
 code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: complete-questionnaire | |
 subject |
SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Patient or other Questionnaire is for ele-1: All FHIR elements must have a @value or children |
 occurrence[x] |
SΣ | 0..1 | When (and possibly how often) the Questionnaire needs to be completed ele-1: All FHIR elements must have a @value or children | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| requester |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service ele-1: All FHIR elements must have a @value or children |
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Who should complete questionnaire ele-1: All FHIR elements must have a @value or children |
| reasonCode |
SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | Pattern: complete-questionnairehttp://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| questionnaire |
1..* | canonical(Questionnaire) | Questionnaire to be completed URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-servicerequest-questionnaire | |||||
| 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. | ||||
| 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 |
Σ | 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 Fixed Value: false | ||||
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. Required Pattern: At least the following | ||||
| 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://hl7.org/fhir/uv/sdc/CodeSystem/temp | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: complete-questionnaire | |||||
| 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] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Patient or other Questionnaire is for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| occurrence[x] |
SΣ | 0..1 | When (and possibly how often) the Questionnaire needs to be completed | |||||
| 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Σ | 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 |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Who should complete questionnaire | ||||
| 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 | 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 |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | Pattern: complete-questionnairehttp://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
This structure is derived from ServiceRequest
Summary
Mandatory: 4 elements
Must-Support: 8 elements
Fixed: 1 element
Extensions
This structure refers to these extensions:
Maturity: 4
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 extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| questionnaire |
1..* | canonical(Questionnaire) | Questionnaire to be completed URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-servicerequest-questionnaire | |
| status |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
| intent |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed Fixed Value: false | |
| code |
S | 1..1 | CodeableConcept | What is being requested/ordered Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: complete-questionnaire | |
| subject |
S | 1..1 | Reference(Patient | Group | Location | Device) | Patient or other Questionnaire is for |
| occurrence[x] |
S | 0..1 | dateTime, Period, Timing | When (and possibly how often) the Questionnaire needs to be completed |
| requester |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| performer |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Who should complete questionnaire |
| reasonCode |
S | 0..* | CodeableConcept | Explanation/Justification for procedure or service |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| questionnaire |
1..* | canonical(Questionnaire) | Questionnaire to be completed URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-servicerequest-questionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children Fixed Value: false |
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: complete-questionnaire | |
| subject |
SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Patient or other Questionnaire is for ele-1: All FHIR elements must have a @value or children |
| occurrence[x] |
SΣ | 0..1 | When (and possibly how often) the Questionnaire needs to be completed ele-1: All FHIR elements must have a @value or children | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| requester |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service ele-1: All FHIR elements must have a @value or children |
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Who should complete questionnaire ele-1: All FHIR elements must have a @value or children |
| reasonCode |
SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | Pattern: complete-questionnairehttp://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| questionnaire |
1..* | canonical(Questionnaire) | Questionnaire to be completed URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-servicerequest-questionnaire | |||||
| 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. | ||||
| 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 |
Σ | 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 Fixed Value: false | ||||
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. Required Pattern: At least the following | ||||
| 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://hl7.org/fhir/uv/sdc/CodeSystem/temp | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: complete-questionnaire | |||||
| 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] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Patient or other Questionnaire is for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| occurrence[x] |
SΣ | 0..1 | When (and possibly how often) the Questionnaire needs to be completed | |||||
| 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Σ | 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 |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Who should complete questionnaire | ||||
| 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 | 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 |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | Pattern: complete-questionnairehttp://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
This structure is derived from ServiceRequest
Summary
Mandatory: 4 elements
Must-Support: 8 elements
Fixed: 1 element
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.sdc#4.0.0-ballot based on FHIR 4.0.1. Generated 2024-12-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change