ServiceRequest
The ServiceRequest resource stores the following types of information:
- Request
- Request for Additional Information
- Submitted Request
Request
Requirements
- Reference to the who and what role updated the record.
- Reference to the who and what role owns the request (Requestor).
- Reference to the applicant
- Reference to the Requestor's location and the status of that location
- Optionally 1 or 2 columns the client wants to see on their WIP list
- Status of the request
- Optionally client business identifiers to reference the request
- A reference to the PDF version of the request once it is submitted
Profile - Request
There is a strange bug that doesn't allow Location.code to have a binding to http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-LocationConfirmationStatuses. If the binding is added then validation will return a Null pointer error.
Example - that passes validation
{ "resourceType": "ServiceRequest", "id": "11111111111111111111111", "meta": { "versionId": "52", "lastUpdated": "2021-11-17T19:50:56.248+00:00", "source": "#mRkuGLBMbhNcBsx5", "profile": [ "http://health.gov.on.ca/sadie/fhir/StructureDefinition/Request" ] }, "text": { "status": "empty", --- We have skipped the narrative for better readability of the resource --- }, "identifier": [ { "system": "urn:sadie:patient:odsp", "value": "2342342342342342" }, { "system": "urn:sadie:request:odsp", "value": "2342342342342342" } ], "status": "draft", "intent": "order", "category": [ { "coding": [ { "system": "https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete", "code": "NEW-REQUEST" } ] } ], "code": { "coding": [ { "system": "https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete", "code": "ODSP" } ] }, "orderDetail": [ { "coding": [ { "system": "https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete", "code": "DetailColumnOneID" } ], "text": "Health Status Report" }, { "coding": [ { "system": "https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete", "code": "DetailColumnTwoID" } ], "text": "Referral ID: 2342342342342342" } ], "subject": { "reference": "Patient/7d0e2f8a-a46b-498a-a808-de81020b1d9d" }, "authoredOn": "2021-09-27T17:36:56Z", "requester": { "reference": "PractitionerRole/cdb3fa96-507b-48ac-8983-cac710085c0c" }, "performer": [ { "reference": "PractitionerRole/cdb3fa96-507b-48ac-8983-cac710085c0c/_history/2" } ], "locationCode": [ { "coding": [ { "system": "https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete", "code": "LOCATION-CONFIRMED" } ] } ], "locationReference": [ { "reference": "Location/cfda55ca-cf33-4fe1-8239-a4d28c0dbd7e" } ], "reasonCode": [ { "coding": [ { "system": "https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete", "code": "HSR" } ] } ] }
Request for Additional Information
Requirements
- The client may want to record their own reference number. (See urn:sadie:childRequest:odsp in the example)
Profile - Request
Example - that passed validation
{ "resourceType": "ServiceRequest", "id": "222222222222222222222", "meta": { "versionId": "9", "lastUpdated": "2021-11-18T13:08:57.864+00:00", "source": "#rRSVJV86nvad3m1r", "profile": [ "http://health.gov.on.ca/sadie/fhir/StructureDefinition/Request" ] }, "text": { "status": "empty", --- We have skipped the narrative for better readability of the resource --- }, "identifier": [ { "system": "urn:sadie:patient:odsp", "value": "2342342342342342" }, { "system": "urn:sadie:request:odsp", "value": "2342342342342342" }, { "system": "urn:sadie:childRequest:odsp", "value": "111111111" } ], "basedOn": [ { "reference": "ServiceRequest/11111111111111111111111" } ], "status": "draft", "intent": "order", "category": [ { "coding": [ { "system": "https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete", "code": "ADDITIONAL-INFORMATION" } ] } ], "code": { "coding": [ { "system": "https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete", "code": "ODSP" } ] }, "subject": { "reference": "Patient/7d0e2f8a-a46b-498a-a808-de81020b1d9d" }, "authoredOn": "2021-09-27T17:36:56Z", "requester": { "reference": "PractitionerRole/cdb3fa96-507b-48ac-8983-cac710085c0c" }, "performer": [ { "reference": "PractitionerRole/cdb3fa96-507b-48ac-8983-cac710085c0c/_history/2" } ], "reasonCode": [ { "coding": [ { "system": "https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete", "code": "ODSP-ADDITIONAL" } ] } ] }
Submitted Request
Requirements
Profile - Request
ServiceRequest | I | ServiceRequest | There are no (further) constraints on this element Element idServiceRequest A request for a service to be performed Alternate namesdiagnostic request, referral, referral request, transfer of care request Definition
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idServiceRequest.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idServiceRequest.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idServiceRequest.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idServiceRequest.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | Element idServiceRequest.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
requestCreatedUser | I | 0..1 | Extension(Reference(FlexFormsRole)) | There are no (further) constraints on this element Element idServiceRequest.extension:requestCreatedUser Optional Extensions Element Alternate namesextensions, user content Definition
|
requestCreatedDate | I | 0..1 | Extension(dateTime) | There are no (further) constraints on this element Element idServiceRequest.extension:requestCreatedDate Optional Extensions Element Alternate namesextensions, user content Definition
|
requestSubmittedUser | I | 0..1 | Extension(Reference(FlexFormsRole)) | There are no (further) constraints on this element Element idServiceRequest.extension:requestSubmittedUser Optional Extensions Element Alternate namesextensions, user content Definition
|
requestSubmittedDate | I | 1..1 | Extension(dateTime) | Element idServiceRequest.extension:requestSubmittedDate Optional Extensions Element Alternate namesextensions, user content Definition
|
requestCompletedDate | I | 0..1 | Extension(dateTime) | There are no (further) constraints on this element Element idServiceRequest.extension:requestCompletedDate Optional Extensions Element Alternate namesextensions, user content Definition
|
requestCompletedDateString | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idServiceRequest.extension:requestCompletedDateString Optional Extensions Element Alternate namesextensions, user content Definition
|
requestSubmittedDateString | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idServiceRequest.extension:requestSubmittedDateString Optional Extensions Element Alternate namesextensions, user content Definition
|
requestClientStatus | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idServiceRequest.extension:requestClientStatus Optional Extensions Element Alternate namesextensions, user content Definition
|
submissionConsent | I | 0..1 | Extension(Reference(TermsOfUseConsent)) | There are no (further) constraints on this element Element idServiceRequest.extension:submissionConsent Optional Extensions Element Alternate namesextensions, user content Definition
|
practitionerName | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idServiceRequest.extension:practitionerName Optional Extensions Element Alternate namesextensions, user content Definition
|
clientCodeOne | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idServiceRequest.extension:clientCodeOne Optional Extensions Element Alternate namesextensions, user content Definition
|
clientCodeTwo | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idServiceRequest.extension:clientCodeTwo Optional Extensions Element Alternate namesextensions, user content Definition
|
applicantName | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idServiceRequest.extension:applicantName Optional Extensions Element Alternate namesextensions, user content Definition
|
searchableString | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idServiceRequest.extension:searchableString Optional Extensions Element Alternate namesextensions, user content Definition
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idServiceRequest.identifier Identifiers assigned to this order Definition
|
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | Σ | 1..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.identifier.system The namespace for the identifier value Definition
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element idServiceRequest.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
instantiatesCanonical | Σ | 0..0 | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idServiceRequest.instantiatesCanonical Instantiates FHIR protocol or definition Definition
|
instantiatesUri | Σ | 0..0 | uri | There are no (further) constraints on this element Element idServiceRequest.instantiatesUri Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
|
basedOn | Σ I | 0..1 | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.basedOn What request fulfills Alternate namesfulfills Definition
|
replaces | Σ I | 0..0 | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.replaces What request replaces Alternate namessupersedes, prior, renewed order DefinitionThe request takes the place of the referenced completed or terminated request(s). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
requisition | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requisition Composite Request ID Alternate namesgrouperId, groupIdentifier DefinitionA shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.status draft | active | on-hold | revoked | completed | entered-in-error | unknown Definition
|
intent | Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idServiceRequest.intent proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Definition
|
category | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.category Classification of service Definition
|
priority | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.priority routine | urgent | asap | stat DefinitionIndicates how quickly the ServiceRequest should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1MB in size If missing, this task should be performed with normal priority Identifies the level of importance to be assigned to actioning the request.
|
doNotPerform | Σ ?! | 0..0 | boolean | There are no (further) constraints on this element Element idServiceRequest.doNotPerform True if service/procedure should not be performed DefinitionSet this to true if the record is saying that the service/procedure should NOT be performed. Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc. In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation. If missing, the request is a positive request e.g. "do perform"
|
code | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.code What is being requested/ordered Alternate namesservice requested DefinitionA code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code. Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.
|
orderDetail | Σ I | 0..2 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.orderDetail Additional order information Alternate namesdetailed instructions Definition
|
quantity[x] | Σ | 0..0 | There are no (further) constraints on this element Element idServiceRequest.quantity[x] Service amount DefinitionAn amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). When ordering a service the number of service items may need to be specified separately from the the service item.
| |
subject | Σ I | 1..1 | Reference(Applicant) | There are no (further) constraints on this element Element idServiceRequest.subject Individual or Entity the service is ordered for Definition
|
encounter | Σ I | 0..0 | Reference(Encounter) | There are no (further) constraints on this element Element idServiceRequest.encounter Encounter in which the request was created Alternate namescontext DefinitionAn encounter that provides additional information about the healthcare context in which this request is made. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
occurrence[x] | Σ | 0..0 | There are no (further) constraints on this element Element idServiceRequest.occurrence[x] When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur.
| |
asNeeded[x] | Σ | 0..0 | There are no (further) constraints on this element Element idServiceRequest.asNeeded[x] Preconditions for service DefinitionIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
| |
authoredOn | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.authoredOn Date request signed Alternate namesorderedOn Definition
|
requester | Σ I | 1..1 | Reference(FlexFormsRole) | There are no (further) constraints on this element Element idServiceRequest.requester Who/what is requesting service Alternate namesauthor, orderer Definition
|
performerType | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.performerType Performer role Alternate namesspecialty DefinitionDesired type of performer for doing the requested service. This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”. Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
|
performer | Σ I | 1..1 | Reference(FlexFormsRole) | There are no (further) constraints on this element Element idServiceRequest.performer Requested performer Alternate namesrequest recipient DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
|
locationCode | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.locationCode Requested location DefinitionThe preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
|
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.locationCode.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.locationCode.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idServiceRequest.locationCode.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.locationCode.coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.locationCode.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uriFixed Value | There are no (further) constraints on this element Element idServiceRequest.locationCode.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
https://health.gov.on.ca/sadie/fhir/CodeSystem/FlexForms-Internal-Complete
|
version | Σ | 0..0 | string | There are no (further) constraints on this element Element idServiceRequest.locationCode.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idServiceRequest.locationCode.coding.code Symbol in syntax defined by the system Definition
|
display | Σ | 0..0 | string | There are no (further) constraints on this element Element idServiceRequest.locationCode.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idServiceRequest.locationCode.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..0 | string | There are no (further) constraints on this element Element idServiceRequest.locationCode.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
locationReference | Σ I | 1..1 | Reference(RequestorLocation) | There are no (further) constraints on this element Element idServiceRequest.locationReference Requested location Definition
|
reasonCode | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.reasonCode Explanation/Justification for procedure or service Definition
|
reasonReference | Σ I | 0..0 | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idServiceRequest.reasonReference Explanation/Justification for service or service DefinitionIndicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in Reference(Condition | Observation | DiagnosticReport | DocumentReference) Constraints
|
insurance | I | 0..0 | Reference(Coverage | ClaimResponse) | There are no (further) constraints on this element Element idServiceRequest.insurance Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Coverage | ClaimResponse) Constraints
|
supportingInfo | I | 1..1 | Reference(Request PDF) | Element idServiceRequest.supportingInfo Additional clinical information Alternate namesAsk at order entry question, AOE Definition
|
specimen | Σ I | 0..0 | Reference(Specimen) | There are no (further) constraints on this element Element idServiceRequest.specimen Procedure Samples DefinitionOne or more specimens that the laboratory procedure will use. Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the Specimen resource points to the ServiceRequest.
|
bodySite | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.bodySite Location on Body Alternate nameslocation DefinitionAnatomic location where the procedure should be performed. This is the target site. Knowing where the procedure is performed is important for tracking if multiple sites are possible. Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure. Codes describing anatomical locations. May include laterality.
|
note | 0..0 | Annotation | There are no (further) constraints on this element Element idServiceRequest.note Comments DefinitionAny other notes and comments made about the service request. For example, internal billing notes. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
patientInstruction | Σ | 0..0 | string | There are no (further) constraints on this element Element idServiceRequest.patientInstruction Patient or consumer-oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer. Note that FHIR strings SHALL NOT exceed 1MB in size
|
relevantHistory | I | 0..0 | Reference(Provenance) | There are no (further) constraints on this element Element idServiceRequest.relevantHistory Request provenance Definition
|
Example - that passed validation To be done