Physical Activity Implementation Guide
1.0.1 - STU Release 1
Physical Activity Implementation Guide
1.0.1 - STU Release 1
Physical Activity Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/physical-activity/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-servicerequest | Version: 1.0.1 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: PAServiceRequest | ||
Represents orders and referrals for interventions that help to improve or maintain a patient’s level of physical activity
This resource is used both for exercise prescriptions where the performer is the Patient,
as well as for referrals, where the performer will be a Practitioner, PractitionerRole, Organization or
unspecified. In the case of referrals, the resource will be used in the workflow described here.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed pa-sr-1: At least one of reasonCode or reasonReference must be provided |
  implicitRules | 0..0 | |||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
   value[x] | 1..1 | ReferenceRest(PA Goal) | Value of extension | |
| observationFocus | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus | |
| value[x] | 1..1 | Reference(PA Related Person) | Value of extension | |
 modifierExtension | 0..0 | |||
| status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error Binding: PA ServiceRequest Status (required) |
| intent | S | 1..1 | code | original-order | order | filler-order Binding: PA ServiceRequest Intents (required) |
 Slices for category | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this | |
 category:PA | S | 1..1 | CodeableConcept | Classification of service 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/us/physical-activity/CodeSystem/pa-temporary-codes | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
 category:USCore | 0..* | CodeableConcept | Classification of service Binding: PA ServiceRequest Category - USCore (required) | |
| priority | S | 0..1 | code | routine | urgent | asap | stat |
| doNotPerform | 0..0 | |||
| code | S | 1..1 | CodeableConcept | What is being requested/ordered Binding: PA ServiceRequest Intervention Codes (extensible) |
| subject | S | 1..1 | ReferenceRest(US Core Patient Profile) | Individual or Entity the service is ordered for |
| Slices for occurrence[x] | S | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
  occurrenceDateTime | dateTime | |||
 occurrencePeriod | Period S | |||
| occurrenceTiming | Timing | |||
 occurrence[x]:occurrencePeriod | S | 0..1 | Period S | When service should occur |
 start | S | 0..1 | dateTime | Starting time with inclusive boundary |
| end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| authoredOn | S | 1..1 | dateTime | Date request signed |
| requester | S | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service |
| performer | S | 0..* | ReferenceRestOrLogical(US Core Patient Profile S | US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S | PA Related Person) | Requested performer |
| reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: US Core Condition Code (extensible) |
| text | S | 0..1 | string | Plain text representation of the concept |
| Slices for reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() | |
| reasonReference:SupportedReasonReference | S | 0..* | Reference(US Core Condition Profile) | Explanation/Justification for service or service |
| Slices for supportingInfo | 0..* | ReferenceRest(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() | |
| supportingInfo:SupportedSupportingInfo | S | 0..* | ReferenceRest(PA Observation EVS Base) | Additional clinical information |
| specimen | 0..0 | |||
 note | 0..* | Annotation | Additional details about the service request | |
| author[x] | S | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S) | Individual responsible for the annotation |
| time | S | 1..1 | dateTime | When the annotation was made |
| text | S | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | PAServiceRequestStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-statusfrom this IG | |
| ServiceRequest.intent | required | PAServiceRequestIntenthttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-intentfrom this IG | |
| ServiceRequest.category:USCore | required | PAServiceRequestCategoryhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-categoryfrom this IG | |
| ServiceRequest.code | extensible | PAServiceRequestInterventionshttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-codefrom this IG | |
| ServiceRequest.reasonCode | extensible | USCoreConditionCodehttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code |
| Id | Grade | Path(s) | Details | Requirements |
| pa-sr-1 | error | ServiceRequest | At least one of reasonCode or reasonReference must be provided : reasonCode.exists() or reasonReference.exists() |
| 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 pa-sr-1: At least one of reasonCode or reasonReference must be provided |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" | |
| value[x] | 1..1 | ReferenceRest(PA Goal) | Value of extension | |
| observationFocus | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus" | |
| value[x] | 1..1 | Reference(PA Related Person) | Value of extension | |
| status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error Binding: PA ServiceRequest Status (required) |
| intent | ?!SΣ | 1..1 | code | original-order | order | filler-order Binding: PA ServiceRequest Intents (required) |
| Slices for category | Σ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:PA | SΣ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. 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/us/physical-activity/CodeSystem/pa-temporary-codes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
| category:USCore | Σ | 0..* | CodeableConcept | Classification of service Binding: PA ServiceRequest Category - USCore (required) |
| priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: PA ServiceRequest Intervention Codes (extensible) |
| subject | SΣ | 1..1 | ReferenceRest(US Core Patient Profile) | Individual or Entity the service is ordered for |
| Slices for occurrence[x] | SΣ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
| occurrencePeriod | Period | |||
| occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period | When service should occur |
| start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary |
| end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| authoredOn | SΣ | 1..1 | dateTime | Date request signed |
| requester | SΣ | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service |
| performer | SΣ | 0..* | ReferenceRestOrLogical(US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Requested performer |
| reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: US Core Condition Code (extensible) |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() |
| reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(US Core Condition Profile) | Explanation/Justification for service or service |
| Slices for supportingInfo | 0..* | ReferenceRest(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() | |
| supportingInfo:SupportedSupportingInfo | S | 0..* | ReferenceRest(PA Observation EVS Base) | Additional clinical information |
| note | 0..* | Annotation | Additional details about the service request | |
| author[x] | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile | US Core Organization Profile) | Individual responsible for the annotation |
| time | SΣ | 1..1 | dateTime | When the annotation was made |
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | PAServiceRequestStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-statusfrom this IG | |
| ServiceRequest.intent | required | PAServiceRequestIntenthttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-intentfrom this IG | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:PA | example | Pattern: PhysicalActivityhttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:USCore | required | PAServiceRequestCategoryhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-categoryfrom this IG | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | extensible | PAServiceRequestInterventionshttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-codefrom this IG | |
| ServiceRequest.reasonCode | extensible | USCoreConditionCodehttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code |
| 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() | |
| pa-sr-1 | error | ServiceRequest | At least one of reasonCode or reasonReference must be provided : reasonCode.exists() or reasonReference.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 prr-1: orderDetail SHALL only be present if code is present pa-sr-1: At least one of reasonCode or reasonReference must be provided | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | |||||
| pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" | |||||
| value[x] | 1..1 | ReferenceRest(PA Goal) | Value of extension | |||||
| observationFocus | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus" | |||||
| value[x] | 1..1 | Reference(PA Related Person) | Value of extension | |||||
| 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 Binding: PA ServiceRequest Status (required) | ||||
| intent | ?!SΣ | 1..1 | code | original-order | order | filler-order Binding: PA ServiceRequest Intents (required) | ||||
| Slices for category | Σ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:PA | SΣ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. 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/us/physical-activity/CodeSystem/pa-temporary-codes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |||||
| 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 | |||||
| category:USCore | Σ | 0..* | CodeableConcept | Classification of service Binding: PA ServiceRequest Category - USCore (required) | ||||
| priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: PA ServiceRequest Intervention Codes (extensible) | ||||
| 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 | ReferenceRest(US Core Patient Profile) | Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| Slices for occurrence[x] | SΣ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period S | |||||||
| occurrenceTiming | Timing | |||||||
| occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period S | When service should occur | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean | boolean | |||||||
| asNeededCodeableConcept | CodeableConcept | |||||||
| authoredOn | SΣ | 1..1 | dateTime | Date request signed | ||||
| requester | SΣ | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer | SΣ | 0..* | ReferenceRestOrLogical(US Core Patient Profile S | US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S | PA Related Person) | 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 | Explanation/Justification for procedure or service Binding: US Core Condition Code (extensible) | ||||
| 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Σ | 0..1 | string | Plain text representation of the concept | ||||
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() | ||||
| reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(US Core Condition Profile) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| Slices for supportingInfo | 0..* | ReferenceRest(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() | |||||
| supportingInfo:SupportedSupportingInfo | S | 0..* | ReferenceRest(PA Observation EVS Base) | Additional clinical information | ||||
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note | 0..* | Annotation | Additional details about the service request | |||||
| 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] | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S) | Individual responsible for the annotation | ||||
| time | SΣ | 1..1 | dateTime | When the annotation was made | ||||
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| 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 | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | PAServiceRequestStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-statusfrom this IG | ||||
| ServiceRequest.intent | required | PAServiceRequestIntenthttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-intentfrom this IG | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:PA | example | Pattern: PhysicalActivityhttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:USCore | required | PAServiceRequestCategoryhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-categoryfrom this IG | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | extensible | PAServiceRequestInterventionshttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-codefrom this IG | ||||
| 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 | extensible | USCoreConditionCodehttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **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() | |
| pa-sr-1 | error | ServiceRequest | At least one of reasonCode or reasonReference must be provided : reasonCode.exists() or reasonReference.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: 5 elements (2 nested mandatory elements)
Must-Support: 21 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed pa-sr-1: At least one of reasonCode or reasonReference must be provided |
| implicitRules | 0..0 | |||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| value[x] | 1..1 | ReferenceRest(PA Goal) | Value of extension | |
| observationFocus | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus | |
| value[x] | 1..1 | Reference(PA Related Person) | Value of extension | |
| modifierExtension | 0..0 | |||
| status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error Binding: PA ServiceRequest Status (required) |
| intent | S | 1..1 | code | original-order | order | filler-order Binding: PA ServiceRequest Intents (required) |
| Slices for category | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this | |
| category:PA | S | 1..1 | CodeableConcept | Classification of service 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/us/physical-activity/CodeSystem/pa-temporary-codes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
| category:USCore | 0..* | CodeableConcept | Classification of service Binding: PA ServiceRequest Category - USCore (required) | |
| priority | S | 0..1 | code | routine | urgent | asap | stat |
| doNotPerform | 0..0 | |||
| code | S | 1..1 | CodeableConcept | What is being requested/ordered Binding: PA ServiceRequest Intervention Codes (extensible) |
| subject | S | 1..1 | ReferenceRest(US Core Patient Profile) | Individual or Entity the service is ordered for |
| Slices for occurrence[x] | S | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period S | |||
| occurrenceTiming | Timing | |||
| occurrence[x]:occurrencePeriod | S | 0..1 | Period S | When service should occur |
| start | S | 0..1 | dateTime | Starting time with inclusive boundary |
| end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| authoredOn | S | 1..1 | dateTime | Date request signed |
| requester | S | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service |
| performer | S | 0..* | ReferenceRestOrLogical(US Core Patient Profile S | US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S | PA Related Person) | Requested performer |
| reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: US Core Condition Code (extensible) |
| text | S | 0..1 | string | Plain text representation of the concept |
| Slices for reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() | |
| reasonReference:SupportedReasonReference | S | 0..* | Reference(US Core Condition Profile) | Explanation/Justification for service or service |
| Slices for supportingInfo | 0..* | ReferenceRest(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() | |
| supportingInfo:SupportedSupportingInfo | S | 0..* | ReferenceRest(PA Observation EVS Base) | Additional clinical information |
| specimen | 0..0 | |||
| note | 0..* | Annotation | Additional details about the service request | |
| author[x] | S | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S) | Individual responsible for the annotation |
| time | S | 1..1 | dateTime | When the annotation was made |
| text | S | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | PAServiceRequestStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-statusfrom this IG | |
| ServiceRequest.intent | required | PAServiceRequestIntenthttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-intentfrom this IG | |
| ServiceRequest.category:USCore | required | PAServiceRequestCategoryhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-categoryfrom this IG | |
| ServiceRequest.code | extensible | PAServiceRequestInterventionshttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-codefrom this IG | |
| ServiceRequest.reasonCode | extensible | USCoreConditionCodehttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code |
| Id | Grade | Path(s) | Details | Requirements |
| pa-sr-1 | error | ServiceRequest | At least one of reasonCode or reasonReference must be provided : reasonCode.exists() or reasonReference.exists() |
Key Elements 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 pa-sr-1: At least one of reasonCode or reasonReference must be provided |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" | |
| value[x] | 1..1 | ReferenceRest(PA Goal) | Value of extension | |
| observationFocus | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus" | |
| value[x] | 1..1 | Reference(PA Related Person) | Value of extension | |
| status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error Binding: PA ServiceRequest Status (required) |
| intent | ?!SΣ | 1..1 | code | original-order | order | filler-order Binding: PA ServiceRequest Intents (required) |
| Slices for category | Σ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:PA | SΣ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. 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/us/physical-activity/CodeSystem/pa-temporary-codes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
| category:USCore | Σ | 0..* | CodeableConcept | Classification of service Binding: PA ServiceRequest Category - USCore (required) |
| priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: PA ServiceRequest Intervention Codes (extensible) |
| subject | SΣ | 1..1 | ReferenceRest(US Core Patient Profile) | Individual or Entity the service is ordered for |
| Slices for occurrence[x] | SΣ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
| occurrencePeriod | Period | |||
| occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period | When service should occur |
| start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary |
| end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
| authoredOn | SΣ | 1..1 | dateTime | Date request signed |
| requester | SΣ | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service |
| performer | SΣ | 0..* | ReferenceRestOrLogical(US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Requested performer |
| reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: US Core Condition Code (extensible) |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() |
| reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(US Core Condition Profile) | Explanation/Justification for service or service |
| Slices for supportingInfo | 0..* | ReferenceRest(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() | |
| supportingInfo:SupportedSupportingInfo | S | 0..* | ReferenceRest(PA Observation EVS Base) | Additional clinical information |
| note | 0..* | Annotation | Additional details about the service request | |
| author[x] | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile | US Core Organization Profile) | Individual responsible for the annotation |
| time | SΣ | 1..1 | dateTime | When the annotation was made |
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.status | required | PAServiceRequestStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-statusfrom this IG | |
| ServiceRequest.intent | required | PAServiceRequestIntenthttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-intentfrom this IG | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:PA | example | Pattern: PhysicalActivityhttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:USCore | required | PAServiceRequestCategoryhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-categoryfrom this IG | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | extensible | PAServiceRequestInterventionshttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-codefrom this IG | |
| ServiceRequest.reasonCode | extensible | USCoreConditionCodehttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code |
| 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() | |
| pa-sr-1 | error | ServiceRequest | At least one of reasonCode or reasonReference must be provided : reasonCode.exists() or reasonReference.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 prr-1: orderDetail SHALL only be present if code is present pa-sr-1: At least one of reasonCode or reasonReference must be provided | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 | |||||
| pertainsToGoal | S | 0..* | Reference(Goal) | Pertains to goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" | |||||
| value[x] | 1..1 | ReferenceRest(PA Goal) | Value of extension | |||||
| observationFocus | 0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.focus" | |||||
| value[x] | 1..1 | Reference(PA Related Person) | Value of extension | |||||
| 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 Binding: PA ServiceRequest Status (required) | ||||
| intent | ?!SΣ | 1..1 | code | original-order | order | filler-order Binding: PA ServiceRequest Intents (required) | ||||
| Slices for category | Σ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:PA | SΣ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. 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/us/physical-activity/CodeSystem/pa-temporary-codes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |||||
| 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 | |||||
| category:USCore | Σ | 0..* | CodeableConcept | Classification of service Binding: PA ServiceRequest Category - USCore (required) | ||||
| priority | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: PA ServiceRequest Intervention Codes (extensible) | ||||
| 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 | ReferenceRest(US Core Patient Profile) | Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| Slices for occurrence[x] | SΣ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period S | |||||||
| occurrenceTiming | Timing | |||||||
| occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period S | When service should occur | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean | boolean | |||||||
| asNeededCodeableConcept | CodeableConcept | |||||||
| authoredOn | SΣ | 1..1 | dateTime | Date request signed | ||||
| requester | SΣ | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile | US Core PractitionerRole Profile) | Who/what is requesting service | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer | SΣ | 0..* | ReferenceRestOrLogical(US Core Patient Profile S | US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S | PA Related Person) | 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 | Explanation/Justification for procedure or service Binding: US Core Condition Code (extensible) | ||||
| 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Σ | 0..1 | string | Plain text representation of the concept | ||||
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service Slice: Unordered, Open by profile:resolve() | ||||
| reasonReference:SupportedReasonReference | SΣ | 0..* | Reference(US Core Condition Profile) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| Slices for supportingInfo | 0..* | ReferenceRest(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() | |||||
| supportingInfo:SupportedSupportingInfo | S | 0..* | ReferenceRest(PA Observation EVS Base) | Additional clinical information | ||||
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note | 0..* | Annotation | Additional details about the service request | |||||
| 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] | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S) | Individual responsible for the annotation | ||||
| time | SΣ | 1..1 | dateTime | When the annotation was made | ||||
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| 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 | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | PAServiceRequestStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-statusfrom this IG | ||||
| ServiceRequest.intent | required | PAServiceRequestIntenthttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-intentfrom this IG | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:PA | example | Pattern: PhysicalActivityhttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:USCore | required | PAServiceRequestCategoryhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-diagnosticreport-categoryfrom this IG | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | extensible | PAServiceRequestInterventionshttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-servicerequest-codefrom this IG | ||||
| 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 | extensible | USCoreConditionCodehttp://hl7.org/fhir/us/core/ValueSet/us-core-condition-code | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **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() | |
| pa-sr-1 | error | ServiceRequest | At least one of reasonCode or reasonReference must be provided : reasonCode.exists() or reasonReference.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: 5 elements (2 nested mandatory elements)
Must-Support: 21 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Patient Care. Package hl7.fhir.us.physical-activity#1.0.1 based on FHIR 4.0.1. Generated 2024-03-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change