Profile: ServiceRequest
AB:eOrder-Lab Simplifier Project Page: ServiceRequest (AB:eOrder-Lab)
Derived from CA:eReC ServiceRequest
Views of Profile Content
ServiceRequestABeOrderLab (ServiceRequest) | C | ServiceRequest | Element idServiceRequestShort description A request for a service to be performed Alternate namesdiagnostic request, referral, referral request, transfer of care request DefinitionA record of a request for service such as diagnostic investigations, treatments, or operations to be performed. ServiceRequest resources included in Alberta eOrder Laboratory Bundles have rules that certain attributes are not to be contained in QuestionnaireResponse resources. These are mechanically enforced through invariants at the AB:eOrder-Lab Bundle level.
| |||
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.idShort description 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.metaShort description 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.implicitRulesShort description 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.languageShort description 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.textShort description 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.containedShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.extensionShort description 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) Constraints
| ||
PatientPresentLocation | C | 0..* | Extension(Reference(Location)) | There are no (further) constraints on this element Element idServiceRequest.extension:PatientPresentLocationShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionUsed to communicate the present location of the patient if it is different than the patient's home address. 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. Extension(Reference(Location)) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Patient-Present-Location-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
DARC | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.extension:DARCShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionDARC stands for 'Dates Affecting Readiness to Consult' and is defines as: Periods of time between the referral and consult date when the patient is unavailable for a first consultation due to patient-related reasons. 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. Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/DARC-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
DART | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.extension:DARTShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionDART stands for 'Dates Affecting Readiness to Treat' and is defined as: Periods of time between the Decision To Treat (DTT) and the Procedure Date when the patient is unavailable for a procedure due to patient-related reasons. 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. Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/DART-ext ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
RoutingOptions | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idServiceRequest.extension:RoutingOptionsShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionFor Referral Source Type identification. Only one referral routing object is expected. 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. http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Routing-Options-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
CopiedParticipants | C | 0..* | Extension(Reference(PractitionerRole)) | There are no (further) constraints on this element Element idServiceRequest.extension:CopiedParticipantsShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Reference(PractitionerRole)) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-copied-participants-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
ServiceProviderPreference | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.extension:ServiceProviderPreferenceShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.modifierExtensionShort description 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.
| ||
identifier | S Σ | 1..* | Identifier | There are no (further) constraints on this element Element idServiceRequest.identifierShort description Identifiers assigned to this order DefinitionIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.identifier.assignerShort description 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..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idServiceRequest.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. canonical(ActivityDefinition | PlanDefinition) Constraints
| ||
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idServiceRequest.instantiatesUriShort description 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 | Σ | 0..1 | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.basedOnShort description 𝗨𝗦𝗘 𝗖𝗔𝗦𝗘 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: Systems that support routing/chaining/splitting SHALL support Alternate namesfulfills DefinitionPlan/proposal/order fulfilled by this request.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.basedOn.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.basedOn.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
replaces | Σ | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.replacesShort description 𝗨𝗦𝗘 𝗖𝗔𝗦𝗘 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: Systems that support routing/chaining/splitting SHALL support Alternate namessupersedes, prior, renewed order DefinitionThe request takes the place of the referenced completed or terminated request(s).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.replaces.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.replaces.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.replaces.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
requisition | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requisitionShort description 𝗨𝗦𝗘 𝗖𝗔𝗦𝗘 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: Systems that support routing/chaining/splitting SHALL support 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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requisition.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.requisition.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.requisition.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.requisition.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.requisition.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.requisition.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.requisition.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.requisition.assignerShort description 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.
| ||
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.statusShort description draft | active | on-hold | revoked | completed | entered-in-error | unknown DefinitionThe status of the order. The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. The status of a service order.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.status.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references) | |||
extension | C | 0..* | Extension | Element idServiceRequest.status.extensionShort description 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) Constraints
| ||
statusReason | S C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.status.extension:statusReasonShort description StatusReasonAB Alternate namesextensions, user content DefinitionAn extension that contains a codeableConcept 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. https://www.alberta.ca/fhir/ab-eorder-lab/StructureDefinition/ext-StatusReasonAB ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
value | 0..1 | System.String | There are no (further) constraints on this element Element idServiceRequest.status.valueShort description Primitive value for code DefinitionPrimitive value for code System.String | |||
intent | S Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idServiceRequest.intentShort description proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option DefinitionWhether the request is a proposal, plan, an original order or a reflex order. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. The kind of service request.
proposalMappings
| ||
category | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.categoryShort description Classification of service DefinitionA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). Used for filtering what service request are retrieved and displayed. There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. Classification of the requested service. http://fhir.infoway-inforoute.ca/ValueSet/interventioncodesubsetcare (preferred) Constraints
| ||
priority | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the ServiceRequest should be addressed with respect to other requests. If missing, this task should be performed with normal priority Identifies the level of importance to be assigned to actioning the request.
| ||
doNotPerform | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.doNotPerformShort description 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 | S Σ | 1..1 | CodeableConceptBinding | Element idServiceRequest.codeShort description Note that the meaning of this field is to be used in conjunction with ServiceRequest.performer pointing to a HealthCareservice, and .code further specifies the service, for example code could be a specific procedure under the specificed HealthcareService (e.g., HealthcareService = Orthopaedic Surgeon, code=Knee Surgery) 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. LaboratoryOrderableCode (extensible) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.code.extensionShort description 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 | S Σ | 1..* | Coding | There are no (further) constraints on this element Element idServiceRequest.code.codingShort description 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.code.coding.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.code.coding.extensionShort description 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 | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.code.coding.systemShort description 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.
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.coding.versionShort description 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 | S Σ | 1..1 | code | There are no (further) constraints on this element Element idServiceRequest.code.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.coding.displayShort description 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.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.code.coding.userSelectedShort description 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..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.textShort description 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.
| ||
orderDetail | Σ C | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.orderDetailShort description Additional order information Alternate namesdetailed instructions DefinitionAdditional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. For information from the medical record intended to support the delivery of the requested services, use the Codified order entry details which are based on order context. ServiceRequestOrderDetailsCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: prr-1 Constraints
| ||
quantity[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.quantity[x]Short description 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.
| |||
quantityQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
quantityRatio | Ratio | There are no (further) constraints on this element Data type | ||||
quantityRange | Range | There are no (further) constraints on this element Data type | ||||
subject | S Σ | 1..1 | Reference(PatientABeOrderLab) | Element idServiceRequest.subjectShort description Individual or Entity the service is ordered for DefinitionOn whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.subject.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.subject.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.subject.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
encounter | Σ | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idServiceRequest.encounterShort description 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.
| ||
occurrence[x] | Σ | 0..1 | Element idServiceRequest.occurrence[x]Short description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur. Unordered, Open, by $this(Type) Constraints
| |||
occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
occurrenceTiming | S Σ | 0..1 | Timing | Element idServiceRequest.occurrence[x]:occurrenceTimingShort description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.extensionShort description 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
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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.
| ||
event | Σ | 0..* | dateTime | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.eventShort description When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
| ||
repeat | Σ C | 0..1 | Element | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeatShort description When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.extensionShort description 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
| ||
bounds[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.bounds[x]Short description Length/Range of lengths, or (Start and/or end) limits DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
| |||
boundsDuration | Duration | There are no (further) constraints on this element Data type | ||||
boundsRange | Range | There are no (further) constraints on this element Data type | ||||
boundsPeriod | Period | There are no (further) constraints on this element Data type | ||||
count | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.countShort description Number of times to repeat DefinitionA total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. Repetitions may be limited by end time or total occurrences. If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
| ||
countMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.countMaxShort description Maximum number of times to repeat DefinitionIf present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
| ||
duration | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationShort description How long when it happens DefinitionHow long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
| ||
durationMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationMaxShort description How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
| ||
durationUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the duration, in UCUM units. A unit of time (units from UCUM).
| ||
frequency | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequencyShort description Event occurs frequency times per period DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
| ||
frequencyMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequencyMaxShort description Event occurs up to frequencyMax times per period DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
| ||
period | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodShort description Event occurs frequency times per period DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
| ||
periodMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodMaxShort description Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
| ||
periodUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the period in UCUM units. A unit of time (units from UCUM).
| ||
dayOfWeek | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeekShort description mon | tue | wed | thu | fri | sat | sun DefinitionIf one or more days of week is provided, then the action happens only on the specified day(s). If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
| ||
timeOfDay | Σ | 0..* | time | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.timeOfDayShort description Time of day for action DefinitionSpecified time of day for action to take place. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
| ||
when | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.whenShort description Code for time period of occurrence DefinitionAn approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events. Real world event relating to the schedule.
| ||
offset | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.offsetShort description Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
| ||
code | Σ | 0..1 | CodeableConceptBinding | Element idServiceRequest.occurrence[x]:occurrenceTiming.codeShort description BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). Code for a known / defined timing pattern. RepeatPatternCode (extensible) Constraints
| ||
asNeeded[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.asNeeded[x]Short description 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. SNOMEDCTMedicationAsNeededReasonCodes (example) Constraints
| |||
asNeededBoolean | boolean | There are no (further) constraints on this element Data type | ||||
asNeededCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
authoredOn | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.authoredOnShort description Date request signed Alternate namesorderedOn DefinitionWhen the request transitioned to being actionable.
| ||
requester | S Σ | 1..1 | Reference(PractitionerRoleABeOrderLab) | Element idServiceRequest.requesterShort description Who/what is requesting service Alternate namesauthor, orderer DefinitionThe individual who initiated the request and has responsibility for its activation. This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource. Reference(PractitionerRoleABeOrderLab) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.requester.extensionShort description 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
| ||
ServiceRequesterDelegate | C | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.requester.extension:ServiceRequesterDelegateShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ext-ServiceRequesterDelegate ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.requester.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requester.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
performerType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.performerTypeShort description 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 | S Σ | 1..* | Reference(HealthcareServiceABeOrderLab) | Element idServiceRequest.performerShort description Requested performer Alternate namesrequest recipient DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). Reference(HealthcareServiceABeOrderLab) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.performer.extensionShort description 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
| ||
PerformerIdentifier | C | 0..1 | Extension(Identifier) | There are no (further) constraints on this element Element idServiceRequest.performer.extension:PerformerIdentifierShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-performer-identifier-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.performer.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.performer.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
locationCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.locationCodeShort description 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. A location type where services are delivered. v3.ServiceDeliveryLocationRoleType (example) Constraints
| ||
locationReference | Σ | 0..* | Reference(Location) | There are no (further) constraints on this element Element idServiceRequest.locationReferenceShort description Requested location DefinitionA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
| ||
reasonCode | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.reasonCodeShort description Explanation/Justification for procedure or service DefinitionAn explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. 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. Use Diagnosis or problem codes justifying the reason for requesting the service investigation. ProcedureReasonCodes (preferred) Constraints
| ||
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idServiceRequest.reasonReferenceShort description 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 | 0..* | Reference(Coverage | ClaimResponse) | There are no (further) constraints on this element Element idServiceRequest.insuranceShort description Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. Reference(Coverage | ClaimResponse) Constraints
| |||
supportingInfo | S | 0..* | Reference(DocumentReferenceABeOrderLab | QuestionnaireResponseABeOrderLab) | Element idServiceRequest.supportingInfoShort description Additional clinical information Alternate namesAsk at order entry question, AOE DefinitionAdditional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. To represent information about how the services are to be delivered use the Reference(DocumentReferenceABeOrderLab | QuestionnaireResponseABeOrderLab) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
specimen | Σ | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idServiceRequest.specimenShort description 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..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.bodySiteShort description 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. SNOMEDCTBodyStructures (example) Constraints
| ||
note | S | 0..* | Annotation | There are no (further) constraints on this element Element idServiceRequest.noteShort description Comments DefinitionAny other notes and comments made about the service request. For example, internal billing notes.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.note.extensionShort description 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
| ||
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment. Unordered, Open, by $this(Type) Constraints
| |||
authorString | string | There are no (further) constraints on this element Data type | ||||
authorReference | Σ | 0..1 | Reference(Practitioner | Organization | Patient) | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReferenceShort description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment. Reference(Practitioner | Organization | Patient) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
text | Σ | 1..1 | markdown | There are no (further) constraints on this element Element idServiceRequest.note.textShort description The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format.
| ||
patientInstruction | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.patientInstructionShort description Patient or consumer-oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer.
| ||
relevantHistory | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idServiceRequest.relevantHistoryShort description Request provenance DefinitionKey events in the history of the request. This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.
|
ServiceRequestABeOrderLab (ServiceRequest) | C | ServiceRequest | Element idServiceRequestShort description A request for a service to be performed Alternate namesdiagnostic request, referral, referral request, transfer of care request DefinitionA record of a request for service such as diagnostic investigations, treatments, or operations to be performed. ServiceRequest resources included in Alberta eOrder Laboratory Bundles have rules that certain attributes are not to be contained in QuestionnaireResponse resources. These are mechanically enforced through invariants at the AB:eOrder-Lab Bundle level.
| |||
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.idShort description 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.metaShort description 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.implicitRulesShort description 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.languageShort description 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.textShort description 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.containedShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.extensionShort description 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) Constraints
| ||
PatientPresentLocation | C | 0..* | Extension(Reference(Location)) | There are no (further) constraints on this element Element idServiceRequest.extension:PatientPresentLocationShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionUsed to communicate the present location of the patient if it is different than the patient's home address. 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. Extension(Reference(Location)) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Patient-Present-Location-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
DARC | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.extension:DARCShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionDARC stands for 'Dates Affecting Readiness to Consult' and is defines as: Periods of time between the referral and consult date when the patient is unavailable for a first consultation due to patient-related reasons. 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. Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/DARC-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
DART | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.extension:DARTShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionDART stands for 'Dates Affecting Readiness to Treat' and is defined as: Periods of time between the Decision To Treat (DTT) and the Procedure Date when the patient is unavailable for a procedure due to patient-related reasons. 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. Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/DART-ext ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
RoutingOptions | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idServiceRequest.extension:RoutingOptionsShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionFor Referral Source Type identification. Only one referral routing object is expected. 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. http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Routing-Options-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
CopiedParticipants | C | 0..* | Extension(Reference(PractitionerRole)) | There are no (further) constraints on this element Element idServiceRequest.extension:CopiedParticipantsShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Reference(PractitionerRole)) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-copied-participants-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
ServiceProviderPreference | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.extension:ServiceProviderPreferenceShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.modifierExtensionShort description 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.
| ||
identifier | S Σ | 1..* | Identifier | There are no (further) constraints on this element Element idServiceRequest.identifierShort description Identifiers assigned to this order DefinitionIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.identifier.assignerShort description 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..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idServiceRequest.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. canonical(ActivityDefinition | PlanDefinition) Constraints
| ||
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idServiceRequest.instantiatesUriShort description 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 | Σ | 0..1 | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.basedOnShort description 𝗨𝗦𝗘 𝗖𝗔𝗦𝗘 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: Systems that support routing/chaining/splitting SHALL support Alternate namesfulfills DefinitionPlan/proposal/order fulfilled by this request.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.basedOn.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.basedOn.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
replaces | Σ | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.replacesShort description 𝗨𝗦𝗘 𝗖𝗔𝗦𝗘 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: Systems that support routing/chaining/splitting SHALL support Alternate namessupersedes, prior, renewed order DefinitionThe request takes the place of the referenced completed or terminated request(s).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.replaces.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.replaces.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.replaces.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
requisition | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requisitionShort description 𝗨𝗦𝗘 𝗖𝗔𝗦𝗘 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: Systems that support routing/chaining/splitting SHALL support 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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requisition.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.requisition.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.requisition.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.requisition.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.requisition.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.requisition.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.requisition.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.requisition.assignerShort description 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.
| ||
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.statusShort description draft | active | on-hold | revoked | completed | entered-in-error | unknown DefinitionThe status of the order. The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. The status of a service order.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.status.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references) | |||
extension | C | 0..* | Extension | Element idServiceRequest.status.extensionShort description 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) Constraints
| ||
statusReason | S C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.status.extension:statusReasonShort description StatusReasonAB Alternate namesextensions, user content DefinitionAn extension that contains a codeableConcept 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. https://www.alberta.ca/fhir/ab-eorder-lab/StructureDefinition/ext-StatusReasonAB ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
value | 0..1 | System.String | There are no (further) constraints on this element Element idServiceRequest.status.valueShort description Primitive value for code DefinitionPrimitive value for code System.String | |||
intent | S Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idServiceRequest.intentShort description proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option DefinitionWhether the request is a proposal, plan, an original order or a reflex order. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. The kind of service request.
proposalMappings
| ||
category | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.categoryShort description Classification of service DefinitionA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). Used for filtering what service request are retrieved and displayed. There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. Classification of the requested service. http://fhir.infoway-inforoute.ca/ValueSet/interventioncodesubsetcare (preferred) Constraints
| ||
priority | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the ServiceRequest should be addressed with respect to other requests. If missing, this task should be performed with normal priority Identifies the level of importance to be assigned to actioning the request.
| ||
doNotPerform | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.doNotPerformShort description 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 | S Σ | 1..1 | CodeableConceptBinding | Element idServiceRequest.codeShort description Note that the meaning of this field is to be used in conjunction with ServiceRequest.performer pointing to a HealthCareservice, and .code further specifies the service, for example code could be a specific procedure under the specificed HealthcareService (e.g., HealthcareService = Orthopaedic Surgeon, code=Knee Surgery) 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. LaboratoryOrderableCode (extensible) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.code.extensionShort description 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 | S Σ | 1..* | Coding | There are no (further) constraints on this element Element idServiceRequest.code.codingShort description 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.code.coding.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.code.coding.extensionShort description 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 | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.code.coding.systemShort description 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.
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.coding.versionShort description 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 | S Σ | 1..1 | code | There are no (further) constraints on this element Element idServiceRequest.code.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.coding.displayShort description 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.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.code.coding.userSelectedShort description 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..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.textShort description 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.
| ||
orderDetail | Σ C | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.orderDetailShort description Additional order information Alternate namesdetailed instructions DefinitionAdditional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. For information from the medical record intended to support the delivery of the requested services, use the Codified order entry details which are based on order context. ServiceRequestOrderDetailsCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: prr-1 Constraints
| ||
quantity[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.quantity[x]Short description 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.
| |||
quantityQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
quantityRatio | Ratio | There are no (further) constraints on this element Data type | ||||
quantityRange | Range | There are no (further) constraints on this element Data type | ||||
subject | S Σ | 1..1 | Reference(PatientABeOrderLab) | Element idServiceRequest.subjectShort description Individual or Entity the service is ordered for DefinitionOn whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.subject.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.subject.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.subject.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
encounter | Σ | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idServiceRequest.encounterShort description 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.
| ||
occurrence[x] | Σ | 0..1 | Element idServiceRequest.occurrence[x]Short description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur. Unordered, Open, by $this(Type) Constraints
| |||
occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
occurrenceTiming | S Σ | 0..1 | Timing | Element idServiceRequest.occurrence[x]:occurrenceTimingShort description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.extensionShort description 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
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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.
| ||
event | Σ | 0..* | dateTime | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.eventShort description When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
| ||
repeat | Σ C | 0..1 | Element | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeatShort description When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.extensionShort description 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
| ||
bounds[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.bounds[x]Short description Length/Range of lengths, or (Start and/or end) limits DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
| |||
boundsDuration | Duration | There are no (further) constraints on this element Data type | ||||
boundsRange | Range | There are no (further) constraints on this element Data type | ||||
boundsPeriod | Period | There are no (further) constraints on this element Data type | ||||
count | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.countShort description Number of times to repeat DefinitionA total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. Repetitions may be limited by end time or total occurrences. If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
| ||
countMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.countMaxShort description Maximum number of times to repeat DefinitionIf present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
| ||
duration | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationShort description How long when it happens DefinitionHow long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
| ||
durationMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationMaxShort description How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
| ||
durationUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the duration, in UCUM units. A unit of time (units from UCUM).
| ||
frequency | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequencyShort description Event occurs frequency times per period DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
| ||
frequencyMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequencyMaxShort description Event occurs up to frequencyMax times per period DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
| ||
period | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodShort description Event occurs frequency times per period DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
| ||
periodMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodMaxShort description Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
| ||
periodUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the period in UCUM units. A unit of time (units from UCUM).
| ||
dayOfWeek | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeekShort description mon | tue | wed | thu | fri | sat | sun DefinitionIf one or more days of week is provided, then the action happens only on the specified day(s). If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
| ||
timeOfDay | Σ | 0..* | time | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.timeOfDayShort description Time of day for action DefinitionSpecified time of day for action to take place. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
| ||
when | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.whenShort description Code for time period of occurrence DefinitionAn approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events. Real world event relating to the schedule.
| ||
offset | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.offsetShort description Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
| ||
code | Σ | 0..1 | CodeableConceptBinding | Element idServiceRequest.occurrence[x]:occurrenceTiming.codeShort description BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). Code for a known / defined timing pattern. RepeatPatternCode (extensible) Constraints
| ||
asNeeded[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.asNeeded[x]Short description 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. SNOMEDCTMedicationAsNeededReasonCodes (example) Constraints
| |||
asNeededBoolean | boolean | There are no (further) constraints on this element Data type | ||||
asNeededCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
authoredOn | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.authoredOnShort description Date request signed Alternate namesorderedOn DefinitionWhen the request transitioned to being actionable.
| ||
requester | S Σ | 1..1 | Reference(PractitionerRoleABeOrderLab) | Element idServiceRequest.requesterShort description Who/what is requesting service Alternate namesauthor, orderer DefinitionThe individual who initiated the request and has responsibility for its activation. This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource. Reference(PractitionerRoleABeOrderLab) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.requester.extensionShort description 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
| ||
ServiceRequesterDelegate | C | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.requester.extension:ServiceRequesterDelegateShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ext-ServiceRequesterDelegate ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.requester.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requester.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
performerType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.performerTypeShort description 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 | S Σ | 1..* | Reference(HealthcareServiceABeOrderLab) | Element idServiceRequest.performerShort description Requested performer Alternate namesrequest recipient DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). Reference(HealthcareServiceABeOrderLab) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.performer.extensionShort description 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
| ||
PerformerIdentifier | C | 0..1 | Extension(Identifier) | There are no (further) constraints on this element Element idServiceRequest.performer.extension:PerformerIdentifierShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-performer-identifier-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.performer.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.performer.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
locationCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.locationCodeShort description 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. A location type where services are delivered. v3.ServiceDeliveryLocationRoleType (example) Constraints
| ||
locationReference | Σ | 0..* | Reference(Location) | There are no (further) constraints on this element Element idServiceRequest.locationReferenceShort description Requested location DefinitionA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
| ||
reasonCode | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.reasonCodeShort description Explanation/Justification for procedure or service DefinitionAn explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. 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. Use Diagnosis or problem codes justifying the reason for requesting the service investigation. ProcedureReasonCodes (preferred) Constraints
| ||
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idServiceRequest.reasonReferenceShort description 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 | 0..* | Reference(Coverage | ClaimResponse) | There are no (further) constraints on this element Element idServiceRequest.insuranceShort description Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. Reference(Coverage | ClaimResponse) Constraints
| |||
supportingInfo | S | 0..* | Reference(DocumentReferenceABeOrderLab | QuestionnaireResponseABeOrderLab) | Element idServiceRequest.supportingInfoShort description Additional clinical information Alternate namesAsk at order entry question, AOE DefinitionAdditional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. To represent information about how the services are to be delivered use the Reference(DocumentReferenceABeOrderLab | QuestionnaireResponseABeOrderLab) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
specimen | Σ | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idServiceRequest.specimenShort description 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..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.bodySiteShort description 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. SNOMEDCTBodyStructures (example) Constraints
| ||
note | S | 0..* | Annotation | There are no (further) constraints on this element Element idServiceRequest.noteShort description Comments DefinitionAny other notes and comments made about the service request. For example, internal billing notes.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.note.extensionShort description 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
| ||
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment. Unordered, Open, by $this(Type) Constraints
| |||
authorString | string | There are no (further) constraints on this element Data type | ||||
authorReference | Σ | 0..1 | Reference(Practitioner | Organization | Patient) | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReferenceShort description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment. Reference(Practitioner | Organization | Patient) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
text | Σ | 1..1 | markdown | There are no (further) constraints on this element Element idServiceRequest.note.textShort description The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format.
| ||
patientInstruction | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.patientInstructionShort description Patient or consumer-oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer.
| ||
relevantHistory | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idServiceRequest.relevantHistoryShort description Request provenance DefinitionKey events in the history of the request. This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.
|
ServiceRequestABeOrderLab (ServiceRequest) | C | ServiceRequest | Element idServiceRequestShort description A request for a service to be performed Alternate namesdiagnostic request, referral, referral request, transfer of care request DefinitionA record of a request for service such as diagnostic investigations, treatments, or operations to be performed. ServiceRequest resources included in Alberta eOrder Laboratory Bundles have rules that certain attributes are not to be contained in QuestionnaireResponse resources. These are mechanically enforced through invariants at the AB:eOrder-Lab Bundle level.
| |||
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.idShort description 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.metaShort description 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.implicitRulesShort description 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.languageShort description 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.textShort description 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.containedShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.extensionShort description 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) Constraints
| ||
PatientPresentLocation | C | 0..* | Extension(Reference(Location)) | There are no (further) constraints on this element Element idServiceRequest.extension:PatientPresentLocationShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionUsed to communicate the present location of the patient if it is different than the patient's home address. 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. Extension(Reference(Location)) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Patient-Present-Location-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
DARC | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.extension:DARCShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionDARC stands for 'Dates Affecting Readiness to Consult' and is defines as: Periods of time between the referral and consult date when the patient is unavailable for a first consultation due to patient-related reasons. 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. Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/DARC-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
DART | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.extension:DARTShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionDART stands for 'Dates Affecting Readiness to Treat' and is defined as: Periods of time between the Decision To Treat (DTT) and the Procedure Date when the patient is unavailable for a procedure due to patient-related reasons. 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. Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/DART-ext ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
RoutingOptions | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idServiceRequest.extension:RoutingOptionsShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionFor Referral Source Type identification. Only one referral routing object is expected. 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. http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Routing-Options-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
CopiedParticipants | C | 0..* | Extension(Reference(PractitionerRole)) | There are no (further) constraints on this element Element idServiceRequest.extension:CopiedParticipantsShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Reference(PractitionerRole)) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-copied-participants-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
ServiceProviderPreference | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.extension:ServiceProviderPreferenceShort description USE CASE SUPPORT: Systems deployed in Ontario SHALL support Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.modifierExtensionShort description 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.
| ||
identifier | S Σ | 1..* | Identifier | There are no (further) constraints on this element Element idServiceRequest.identifierShort description Identifiers assigned to this order DefinitionIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.identifier.assignerShort description 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..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idServiceRequest.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. canonical(ActivityDefinition | PlanDefinition) Constraints
| ||
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idServiceRequest.instantiatesUriShort description 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 | Σ | 0..1 | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.basedOnShort description 𝗨𝗦𝗘 𝗖𝗔𝗦𝗘 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: Systems that support routing/chaining/splitting SHALL support Alternate namesfulfills DefinitionPlan/proposal/order fulfilled by this request.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.basedOn.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.basedOn.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.basedOn.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.basedOn.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
replaces | Σ | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.replacesShort description 𝗨𝗦𝗘 𝗖𝗔𝗦𝗘 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: Systems that support routing/chaining/splitting SHALL support Alternate namessupersedes, prior, renewed order DefinitionThe request takes the place of the referenced completed or terminated request(s).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.replaces.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.replaces.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.replaces.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.replaces.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.replaces.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
requisition | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requisitionShort description 𝗨𝗦𝗘 𝗖𝗔𝗦𝗘 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: Systems that support routing/chaining/splitting SHALL support 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.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requisition.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.requisition.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.requisition.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.requisition.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.requisition.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.requisition.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.requisition.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.requisition.assignerShort description 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.
| ||
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.statusShort description draft | active | on-hold | revoked | completed | entered-in-error | unknown DefinitionThe status of the order. The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. The status of a service order.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.status.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references) | |||
extension | C | 0..* | Extension | Element idServiceRequest.status.extensionShort description 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) Constraints
| ||
statusReason | S C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.status.extension:statusReasonShort description StatusReasonAB Alternate namesextensions, user content DefinitionAn extension that contains a codeableConcept 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. https://www.alberta.ca/fhir/ab-eorder-lab/StructureDefinition/ext-StatusReasonAB ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
value | 0..1 | System.String | There are no (further) constraints on this element Element idServiceRequest.status.valueShort description Primitive value for code DefinitionPrimitive value for code System.String | |||
intent | S Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idServiceRequest.intentShort description proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option DefinitionWhether the request is a proposal, plan, an original order or a reflex order. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. The kind of service request.
proposalMappings
| ||
category | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.categoryShort description Classification of service DefinitionA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). Used for filtering what service request are retrieved and displayed. There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. Classification of the requested service. http://fhir.infoway-inforoute.ca/ValueSet/interventioncodesubsetcare (preferred) Constraints
| ||
priority | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the ServiceRequest should be addressed with respect to other requests. If missing, this task should be performed with normal priority Identifies the level of importance to be assigned to actioning the request.
| ||
doNotPerform | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.doNotPerformShort description 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 | S Σ | 1..1 | CodeableConceptBinding | Element idServiceRequest.codeShort description Note that the meaning of this field is to be used in conjunction with ServiceRequest.performer pointing to a HealthCareservice, and .code further specifies the service, for example code could be a specific procedure under the specificed HealthcareService (e.g., HealthcareService = Orthopaedic Surgeon, code=Knee Surgery) 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. LaboratoryOrderableCode (extensible) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.code.extensionShort description 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 | S Σ | 1..* | Coding | There are no (further) constraints on this element Element idServiceRequest.code.codingShort description 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.code.coding.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.code.coding.extensionShort description 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 | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.code.coding.systemShort description 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.
| ||
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.coding.versionShort description 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 | S Σ | 1..1 | code | There are no (further) constraints on this element Element idServiceRequest.code.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.coding.displayShort description 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.
| ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.code.coding.userSelectedShort description 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..1 | string | There are no (further) constraints on this element Element idServiceRequest.code.textShort description 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.
| ||
orderDetail | Σ C | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.orderDetailShort description Additional order information Alternate namesdetailed instructions DefinitionAdditional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. For information from the medical record intended to support the delivery of the requested services, use the Codified order entry details which are based on order context. ServiceRequestOrderDetailsCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: prr-1 Constraints
| ||
quantity[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.quantity[x]Short description 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.
| |||
quantityQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
quantityRatio | Ratio | There are no (further) constraints on this element Data type | ||||
quantityRange | Range | There are no (further) constraints on this element Data type | ||||
subject | S Σ | 1..1 | Reference(PatientABeOrderLab) | Element idServiceRequest.subjectShort description Individual or Entity the service is ordered for DefinitionOn whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.subject.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.subject.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.subject.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.subject.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.subject.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
encounter | Σ | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idServiceRequest.encounterShort description 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.
| ||
occurrence[x] | Σ | 0..1 | Element idServiceRequest.occurrence[x]Short description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur. Unordered, Open, by $this(Type) Constraints
| |||
occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
occurrenceTiming | S Σ | 0..1 | Timing | Element idServiceRequest.occurrence[x]:occurrenceTimingShort description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.extensionShort description 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
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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.
| ||
event | Σ | 0..* | dateTime | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.eventShort description When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
| ||
repeat | Σ C | 0..1 | Element | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeatShort description When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.extensionShort description 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
| ||
bounds[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.bounds[x]Short description Length/Range of lengths, or (Start and/or end) limits DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
| |||
boundsDuration | Duration | There are no (further) constraints on this element Data type | ||||
boundsRange | Range | There are no (further) constraints on this element Data type | ||||
boundsPeriod | Period | There are no (further) constraints on this element Data type | ||||
count | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.countShort description Number of times to repeat DefinitionA total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. Repetitions may be limited by end time or total occurrences. If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
| ||
countMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.countMaxShort description Maximum number of times to repeat DefinitionIf present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
| ||
duration | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationShort description How long when it happens DefinitionHow long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
| ||
durationMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationMaxShort description How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
| ||
durationUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the duration, in UCUM units. A unit of time (units from UCUM).
| ||
frequency | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequencyShort description Event occurs frequency times per period DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
| ||
frequencyMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.frequencyMaxShort description Event occurs up to frequencyMax times per period DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
| ||
period | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodShort description Event occurs frequency times per period DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
| ||
periodMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodMaxShort description Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
| ||
periodUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the period in UCUM units. A unit of time (units from UCUM).
| ||
dayOfWeek | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeekShort description mon | tue | wed | thu | fri | sat | sun DefinitionIf one or more days of week is provided, then the action happens only on the specified day(s). If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
| ||
timeOfDay | Σ | 0..* | time | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.timeOfDayShort description Time of day for action DefinitionSpecified time of day for action to take place. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
| ||
when | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.whenShort description Code for time period of occurrence DefinitionAn approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events. Real world event relating to the schedule.
| ||
offset | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]:occurrenceTiming.repeat.offsetShort description Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
| ||
code | Σ | 0..1 | CodeableConceptBinding | Element idServiceRequest.occurrence[x]:occurrenceTiming.codeShort description BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). Code for a known / defined timing pattern. RepeatPatternCode (extensible) Constraints
| ||
asNeeded[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.asNeeded[x]Short description 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. SNOMEDCTMedicationAsNeededReasonCodes (example) Constraints
| |||
asNeededBoolean | boolean | There are no (further) constraints on this element Data type | ||||
asNeededCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
authoredOn | S Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.authoredOnShort description Date request signed Alternate namesorderedOn DefinitionWhen the request transitioned to being actionable.
| ||
requester | S Σ | 1..1 | Reference(PractitionerRoleABeOrderLab) | Element idServiceRequest.requesterShort description Who/what is requesting service Alternate namesauthor, orderer DefinitionThe individual who initiated the request and has responsibility for its activation. This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource. Reference(PractitionerRoleABeOrderLab) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.requester.extensionShort description 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
| ||
ServiceRequesterDelegate | C | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idServiceRequest.requester.extension:ServiceRequesterDelegateShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ext-ServiceRequesterDelegate ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.requester.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requester.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.requester.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.requester.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
performerType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.performerTypeShort description 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 | S Σ | 1..* | Reference(HealthcareServiceABeOrderLab) | Element idServiceRequest.performerShort description Requested performer Alternate namesrequest recipient DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). Reference(HealthcareServiceABeOrderLab) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.performer.extensionShort description 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
| ||
PerformerIdentifier | C | 0..1 | Extension(Identifier) | There are no (further) constraints on this element Element idServiceRequest.performer.extension:PerformerIdentifierShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-performer-identifier-EXT ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.performer.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.performer.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.performer.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.performer.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
locationCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.locationCodeShort description 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. A location type where services are delivered. v3.ServiceDeliveryLocationRoleType (example) Constraints
| ||
locationReference | Σ | 0..* | Reference(Location) | There are no (further) constraints on this element Element idServiceRequest.locationReferenceShort description Requested location DefinitionA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
| ||
reasonCode | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.reasonCodeShort description Explanation/Justification for procedure or service DefinitionAn explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. 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. Use Diagnosis or problem codes justifying the reason for requesting the service investigation. ProcedureReasonCodes (preferred) Constraints
| ||
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idServiceRequest.reasonReferenceShort description 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 | 0..* | Reference(Coverage | ClaimResponse) | There are no (further) constraints on this element Element idServiceRequest.insuranceShort description Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. Reference(Coverage | ClaimResponse) Constraints
| |||
supportingInfo | S | 0..* | Reference(DocumentReferenceABeOrderLab | QuestionnaireResponseABeOrderLab) | Element idServiceRequest.supportingInfoShort description Additional clinical information Alternate namesAsk at order entry question, AOE DefinitionAdditional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. To represent information about how the services are to be delivered use the Reference(DocumentReferenceABeOrderLab | QuestionnaireResponseABeOrderLab) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.supportingInfo.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
specimen | Σ | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idServiceRequest.specimenShort description 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..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.bodySiteShort description 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. SNOMEDCTBodyStructures (example) Constraints
| ||
note | S | 0..* | Annotation | There are no (further) constraints on this element Element idServiceRequest.noteShort description Comments DefinitionAny other notes and comments made about the service request. For example, internal billing notes.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.note.extensionShort description 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
| ||
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment. Unordered, Open, by $this(Type) Constraints
| |||
authorString | string | There are no (further) constraints on this element Data type | ||||
authorReference | Σ | 0..1 | Reference(Practitioner | Organization | Patient) | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReferenceShort description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment. Reference(Practitioner | Organization | Patient) Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.extensionShort description 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
| ||
reference | S Σ C | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
| ||
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.idShort description 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 | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.extensionShort description 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..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.useShort description 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..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.typeShort description 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. Identifier Type Codes (extensible) Constraints
| ||
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.valueShort description 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 123456Mappings
| ||
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.identifier.assignerShort description 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.
| ||
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.note.author[x]:authorReference.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
text | Σ | 1..1 | markdown | There are no (further) constraints on this element Element idServiceRequest.note.textShort description The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format.
| ||
patientInstruction | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.patientInstructionShort description Patient or consumer-oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer.
| ||
relevantHistory | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idServiceRequest.relevantHistoryShort description Request provenance DefinitionKey events in the history of the request. This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.
|
Restrictions
Alberta eOrder Laboratory (AB:eOrder-Lab) employs a set of constraints on the Bundle (AB:eOrder-Lab) Profile that prevents laboratory orders created in Alberta to include certain elements from ServiceRequest
.
ServiceRequest records sent in an AB:eOrder-Lab Bundle
SHALL NOT contain any of the following `ServiceRequest details:
- .contained
- .replaces
- .reasonReference
- **.insurance
- .relevantHistory
These elements are restricted based on current privacy requirements that require data that is collected, used or disclosed be limited to only the amount of health information that is essential to enable the custodian or the recipient of the information to carry out the intended purpose.
Usage
Information about a healthcare provider's laboratory order to be performed for a patient.
The ServiceRequest
resource contains the key information about lab test being requested, who requested it, which patient it's for, who is assigned to perform.
Notes
.id
- TESTED element
- an identifier for the
ServiceRequest
resource, unique within the submitted bundle - if a persistent identity for the resource is not available to use when constructing a
Bundle
for transmission, a UUID SHOULD be used in this element (with a corresponding value inBundle.entry.fullUrl
)
.meta
- TESTED element
- metadata about the
ServiceRequest
resource, relevant to the submission or data exchange. .lastUpdated
- TESTED element
- the date and time when the
ServiceRequest
was last updated, spanning all contained resources and data elements - contains the create-date for a new request, or the date when it was most recently updated by the ordering provider or by any workflow participant authorized to create or change the request
.identifier
- TESTED element
- one or more version-independent identifiers for the
ServiceRequest
resource - SHALL always be populated
- TBD additional guidance...
.system
- TESTED element
- the namespace / naming system used for this service request identifier
- SHALL always be populated
.value
- TESTED element
- the value of the assigned service request identifier
- SHALL always be populated
.basedOn
- CONDITIONALLY TESTED element
- links this particular
ServiceRequest
to another existingServiceRequest
, when both are explicitly linked - if an identifier is previously known to both systems,
.identifier
SHALL be populated and used for reference to minimize the amount of detail required from submitting systems - otherwise
.reference
SHALL be used- the referenced resource SHALL be included in the
Bundle.entry
- SHALL be the UUID in the
Bundle.entry.fullURL
of the referenced resource
- the referenced resource SHALL be included in the
.status
- TESTED element
- the workflow state of the service request
- SHALL always be populated
- SHALL be set to
'active'
when ordered and will remain in that state until'completed'
or'revoked'
.intent
- TESTED element
- the intention and authorization underlying the service request, indicating how it should be received and acted upon
- SHALL always be populated with fixed value of
'proposal'
- a nationally-defined set of standard values cannot be modified or extended. The value of
'proposal'
is standard for referral and eConsult requests
.priority
- TESTED element
- the priority with which the service request should be addressed with respect to other requests
- SHALL always be provided
- SHALL only use
'routine'
(default value) and'stat'
.code
- TESTED element
- a code or text description identifying the type of laboratory test being requested
- SHALL be populated from the provincially published list of eligible codes
- NOTE the codes provided in the bound value set do not constitute the full list, only a few examples
- SHALL always be populated
.coding
- TESTED element
.code
- TESTED element
- a codified value that represents the type of laboratory test ordered
- SHALL always be populated
.system
- TESTED element
- the terminology system used by the code
- SHALL always be populated
.text
- TESTED element
- the name or textual description of the type of laboratory test ordered
- SHOULD be populated with the published text from Alberta Health to EMRs, accompanying the allowed codes
.orderDetail
- TESTED element
- any additional notes or details that the ordering provider may choose to include (e.g. lab instructions)
- if populated, only
.text
SHALL be used
.subject
- TESTED element
- a reference to the
Patient
resource of the submitted service request, specifying that the patient is the subject of the requested service - SHALL always be populated
.reference
- TESTED element
- a reference to the associated subject (patient) resource within the submission bundle
.type
- TESTED element
- identifies the type of FHIR resource used to convey the subject's information
.identifier
- TESTED element
.system
- TESTED element
- SHALL always be populated
.value
- TESTED element
- SHALL always be populated
- the
Patient
resource SHALL be included on any newServiceRequest
, but can be referenced through the patient's provicial identifier (without needing to include thePatient
resource in theBundle
) on subsequent updates to theServiceRequest
or when theServiceRequest
is otherwise included in theBundle
- if an identifier is previously known to both systems,
.identifier
SHALL be populated and used for reference to minimize the amount of detail required from submitting systems - otherwise
.reference
SHALL be used- the referenced resource SHALL be included in the
Bundle.entry
- SHALL be the UUID in the
Bundle.entry.fullURL
of the referenced resource
- the referenced resource SHALL be included in the
.occurence[x]
- TESTED element
.occurenceTiming
- TESTED element
.repeat
- TESTED element
.boundsPeriod
- TESTED element
.start
- TESTED element
- indicates when the order is to be started
- start date SHALL NOT be more than one year in the future
.end
- indicates when the order is to be ended
- end date SHALL NOT be more than one year from the filing date in Connect Care
.count
- TESTED element
- indicates the total occurrences
.code
- TESTED element
- indicates the frequency
The following table shows how the .occurenceTiming
will be populated according to whether the order is single occurence or standing order:
Single Occurrence
Element | Optionality | Value | Comment |
---|---|---|---|
.occurenceTiming.repeat.boundsPeriod.start |
Optional | Desired date and time | SHALL be valued if desired start date and time is in the future |
.occurenceTiming.repeat.boundsPeriod.end |
Optional | Desired date and time | SHALL be valued if there is a specific desired end date, otherwise order will expire in 1 year after order date |
.occurenceTiming.repeat.boundsPeriod.count |
N/A | N/A | SHALL NOT be valued |
.occurenceTiming.code |
N/A | N/A | SHALL NOT be valued |
Standing Order
Element | Optionality | Value | Comment |
---|---|---|---|
.occurenceTiming.repeat.boundsPeriod.start |
Optional | Desired date and time | SHALL be valued if desired start date and time is in the future |
.occurenceTiming.repeat.boundsPeriod.end |
Optional | Desired date and time | SHALL be valued if there is a specific desired end date, otherwise order will expire in 1 year after order date |
.occurenceTiming.repeat.boundsPeriod.count |
Required | >1 | |
.occurenceTiming.code |
Required | Desired frequency |
.authoredOn
- TESTED element
- the date and time when the service request was created from the source system's information and submitted for action
- SHALL always be populated
.requester
- TESTED element
- a reference to the healthcare provider role resource for the provider requesting the service, specifying the requesting healthcare provider's role, services, and location for the purpose of this service request
- SHALL always be populated
.reference
- TESTED element
- a reference to the associated healthcare provider role resource within the submission bundle
.type
- TESTED element
- identifies the type of FHIR resource used to convey the requester's information
.performer
- TESTED element
- a reference to the resource of the performer requested to fulfill the service
- SHALL always be populated
.reference
- TESTED element
- a reference to the associated resource within the submission bundle
type
- TESTED element
- identifies the type of FHIR resource used to convey the requested performer's information
.supportingInfo
- TESTED element
- refers to either an additional information such as questions and answers specific to laboratory test ordered (
QuestionnaireResponse
) and/or the requisition in PDF format (DocumentReference
) .reference
- TESTED element
- a reference to the associated supporting information (
QuestionnaireResponse
orDocumentReference
) within the submission bundle
.type
- TESTED element
- identifies the type of FHIR resource used to convey the supporting information
.specimen
- TESTED element
- specimen that the laboratory procedure will use
- SHALL always be populated
.reference
- TESTED element
- a reference to the associated
Specimen
within the submission bundle
.type
- TESTED element
- identifies the type of FHIR resource used to convey the specimen
.bodySite
- SHALL NOT be used; see
Specimen.collection.bodySite.text
Extensions
- .CopiedParticipants
- TESTED element
- when valued, these are the providers who will be copied on results distribution
- note: the Alberta PractitionerRole, Practitioner, and Location profiles were intentionally not used for this purpose as there are certain constraints (e.g. mandatory identifier) that are not available for the copy to provider.
.PractitionerRole.Practioner
- CONDITIONALLY TESTED element including all the following elements:
.name
.family
- if
.CopiedParticipants
is valued,.family
SHALL always be populated
- if
.given
- if
.CopiedParticipants
is valued,.name
SHALL always be populated with full first name
- if
.PractitionerRole.Location
- CONDITIONALLY TESTED element including all the following elements:
.name
- if
.CopiedParticipants
is valued,.name
SHALL always be populated
- if
.telecom
- if
.CopiedParticipants
is valued, the following SHOULD be populated.value
.system
- if
.address
- if
.CopiedParticipants
is valued, the following SHOULD be populated.line
.city
.state
.postalCode
- if
- .status.extension.statusReason
.text
- CONDITIONALLY TESTED element
- used to capture reason for status change (e.g. cancellation reason from EMR)
- SHOULD be populated when EMR cancels a lab test