Profile: CareConnect-GPC-ProcedureRequest-1
CareConnect-GPC-ProcedureRequest-1 (ProcedureRequest) | C | ProcedureRequest | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | 0..* | Extension | |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
profile | Σ | 1..* | uri |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
modifierExtension | ?! | 0..* | Extension |
identifier | Σ | 1..* | Identifier |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) |
basedOn | Σ | 0..* | Reference(Resource) |
replaces | Σ | 0..* | Reference(Resource) |
requisition | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(CareConnect-GPC-Organization-1) |
status | Σ ?! | 1..1 | codeBindingAuto Value |
intent | Σ ?! | 1..1 | codeBinding |
priority | Σ | 0..1 | codeBinding |
doNotPerform | Σ ?! | 0..1 | boolean |
category | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
descriptionId | C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueId | 0..1 | id | |
descriptionDisplay | C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueString | 0..1 | string | |
url | 1..1 | uriAuto Value | |
value[x] | 0..0 | ||
system | Σ | 1..1 | uriAuto Value |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
code | Σ | 1..1 | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
descriptionId | C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueId | 0..1 | id | |
descriptionDisplay | C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueString | 0..1 | string | |
url | 1..1 | uriAuto Value | |
value[x] | 0..0 | ||
system | Σ | 1..1 | uriAuto Value |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
subject | Σ | 1..1 | Reference(Device | CareConnect-GPC-Patient-1 | CareConnect-GPC-Location-1) |
context | Σ | 0..1 | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-GPC-Encounter-1) |
occurrence[x] | Σ | 0..1 | |
occurrenceDateTime | dateTime | ||
occurrencePeriod | Period | ||
occurrenceTiming | Timing | ||
asNeeded[x] | Σ | 0..1 | |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
authoredOn | Σ | 0..1 | dateTime |
requester | S Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
agent | Σ | 1..1 | Reference(Device | CareConnect-GPC-Organization-1 | CareConnect-GPC-Practitioner-1) |
onBehalfOf | Σ | 0..1 | Reference(CareConnect-GPC-Organization-1) |
performerType | Σ | 0..1 | CodeableConcept |
performer | S Σ | 0..1 | Reference(CareConnect-GPC-Organization-1 | CareConnect-GPC-Practitioner-1) |
reasonCode | S Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
descriptionId | C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueId | 0..1 | id | |
descriptionDisplay | C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueString | 0..1 | string | |
url | 1..1 | uriAuto Value | |
value[x] | 0..0 | ||
system | Σ | 1..1 | uriAuto Value |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
reasonReference | S Σ | 0..* | Reference(CareConnect-GPC-Condition-1 | CareConnect-GPC-Observation-1) |
supportingInfo | 0..* | Reference(Resource | CareConnect-GPC-Observation-1) | |
specimen | Σ | 0..* | Reference(CareConnect-GPC-Specimen-1) |
bodySite | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..* | CodingBinding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
descriptionId | C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueId | 0..1 | id | |
descriptionDisplay | C | 1..1 | Extension |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueString | 0..1 | string | |
url | 1..1 | uriAuto Value | |
value[x] | 0..0 | ||
system | Σ | 1..1 | uriAuto Value |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
note | S | 0..* | Annotation |
id | 0..1 | string | |
extension | 0..* | Extension | |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference(CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1 | CareConnect-RelatedPerson-1) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string | |
relevantHistory | 0..* | Reference(Provenance) |
ProcedureRequest | |||
Short | A request for a procedure or diagnostic to be performed | ||
Definition | A record of a request for diagnostic investigations, treatments, or operations to be performed. | ||
Cardinality | 0..* | ||
Alias | diagnostic request | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
ProcedureRequest.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
ProcedureRequest.meta.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.meta.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.meta.versionId | |||
Short | Version specific identifier | ||
Definition | The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||
ProcedureRequest.meta.lastUpdated | |||
Short | When the resource version last changed | ||
Definition | When the resource last changed - e.g. when the version changed. | ||
Cardinality | 0..1 | ||
Type | instant | ||
Summary | True | ||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. | ||
ProcedureRequest.meta.profile | |||
Short | Profiles this resource claims to conform to | ||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||
Cardinality | 1..* | ||
Type | uri | ||
Summary | True | ||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||
ProcedureRequest.meta.security | |||
Short | Security Labels applied to this resource | ||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Binding | Security Labels from the Healthcare Privacy and Security Classification System. | ||
Summary | True | ||
Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||
ProcedureRequest.meta.tag | |||
Short | Tags applied to this resource | ||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||
Summary | True | ||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||
ProcedureRequest.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
ProcedureRequest.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | 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). | ||
ProcedureRequest.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may 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. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | 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 in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
ProcedureRequest.contained | |||
Short | Contained, inline Resources | ||
Definition | These 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. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May 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. Usually modifier elements provide negation or qualification. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.identifier | |||
Short | Identifiers assigned to this order | ||
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. | ||
Cardinality | 1..* | ||
Type | Identifier | ||
Summary | True | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.identifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
ProcedureRequest.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.identifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | 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. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
ProcedureRequest.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Comments | 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. | ||
Examples | General123456 | ||
Mappings |
| ||
ProcedureRequest.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
ProcedureRequest.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference(Organization) | ||
Summary | True | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.definition | |||
Short | Protocol or definition | ||
Definition | Protocol or definition followed by this request. | ||
Cardinality | 0..* | ||
Type | Reference(ActivityDefinition | PlanDefinition) | ||
Summary | True | ||
Alias | protocol | ||
Mappings |
| ||
ProcedureRequest.basedOn | |||
Short | What request fulfills | ||
Definition | Plan/proposal/order fulfilled by this request. | ||
Cardinality | 0..* | ||
Type | Reference(Resource) | ||
Summary | True | ||
Alias | fulfills | ||
Mappings |
| ||
ProcedureRequest.replaces | |||
Short | What request replaces | ||
Definition | The request takes the place of the referenced completed or terminated request(s). | ||
Cardinality | 0..* | ||
Type | Reference(Resource) | ||
Summary | True | ||
Mappings |
| ||
ProcedureRequest.requisition | |||
Short | Composite Request ID | ||
Definition | A shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. | ||
Cardinality | 0..1 | ||
Type | Identifier | ||
Summary | True | ||
Alias | grouperId, groupIdentifier | ||
Requirements | Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.requisition.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.requisition.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.requisition.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
ProcedureRequest.requisition.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.requisition.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | 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. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
ProcedureRequest.requisition.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | 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. | ||
Examples | General123456 | ||
Mappings |
| ||
ProcedureRequest.requisition.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
ProcedureRequest.requisition.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Organization-1) | ||
Summary | True | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.status | |||
Short | draft | active | suspended | completed | entered-in-error | cancelled | ||
Definition | The status of the ProcedureRequest. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The status of a procedure or diagnostic order. | ||
Modifier | True | ||
Summary | True | ||
Comments | 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. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||
Auto Value | active | ||
Mappings |
| ||
ProcedureRequest.intent | |||
Short | proposal | plan | order + | ||
Definition | Whether the request is a proposal, plan, an original order or a reflex order. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The kind of procedure or diagnostic request | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. | ||
Mappings |
| ||
ProcedureRequest.priority | |||
Short | routine | urgent | asap | stat | ||
Definition | Indicates how quickly the ProcedureRequest should be addressed with respect to other requests. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the level of importance to be assigned to actioning the request | ||
Summary | True | ||
Meaning when missing | If missing, this task should be performed with normal priority | ||
Mappings |
| ||
ProcedureRequest.doNotPerform | |||
Short | True if procedure should not be performed | ||
Definition | Set this to true if the record is saying that the procedure should NOT be performed. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Modifier | True | ||
Summary | True | ||
Requirements | 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. | ||
Comments | This element is labeled as a modifier because it indicates that a procedure shouldn't happen, instead of a request for it to happen. 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 ProcedureRequest.code and ProcedureRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation. | ||
Default value | false | ||
Mappings |
| ||
ProcedureRequest.category | |||
Short | Classification of procedure | ||
Definition | A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | Classification of the procedure | ||
Summary | True | ||
Requirements | Used for filtering what procedure request are retrieved and displayed. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.category.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.category.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.category.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | 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. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId | |||
Short | The SNOMED CT Description ID | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | descriptionId | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId | |||
Short | The SNOMED CT Description ID | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | id | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay | |||
Short | The SNOMED CT display for the description ID | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | descriptionDisplay | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString | |||
Short | The SNOMED CT display for the description ID | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..0 | ||
Type | Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously. | ||
Auto Value | http://snomed.info/sct | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
Definition | The 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. | ||
Cardinality | 0..0 | ||
Type | string | ||
Summary | True | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A 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). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
ProcedureRequest.category.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | 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. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.category.text | |||
Short | Plain text representation of the concept | ||
Definition | A 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | 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. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
ProcedureRequest.code | |||
Short | The tests requested by the requesting health care professional. | ||
Definition | A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | Codes for tests/services that can be performed by procedure or diagnostic services. For laboratory, LOINC is (preferred)[http://hl7.org/fhir/STU3/terminologies.html#preferred] and a valueset using LOINC Order codes is available [here](valueset-diagnostic-requests.html). | ||
Summary | True | ||
Comments | Many laboratory and radiology procedure codes embed the specimen/organ system in the test ordeer name, for example, serum or serum/plasma glucose, or a chest xray. The specimen may not be recorded separately from the test code. | ||
Mappings |
| ||
ProcedureRequest.code.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.code.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.code.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | 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. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId | |||
Short | The SNOMED CT Description ID | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | descriptionId | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId | |||
Short | The SNOMED CT Description ID | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | id | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay | |||
Short | The SNOMED CT display for the description ID | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | descriptionDisplay | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString | |||
Short | The SNOMED CT display for the description ID | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..0 | ||
Type | Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously. | ||
Auto Value | http://snomed.info/sct | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
Definition | The 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. | ||
Cardinality | 0..0 | ||
Type | string | ||
Summary | True | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A 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). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
ProcedureRequest.code.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | 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. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.code.text | |||
Short | Plain text representation of the concept | ||
Definition | A 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | 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. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
ProcedureRequest.subject | |||
Short | A reference to the Patient that the ProcedureRequest is about. | ||
Definition | On whom or what the procedure or diagnostic 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). | ||
Cardinality | 1..1 | ||
Type | Reference(Device | CareConnect-GPC-Patient-1 | CareConnect-GPC-Location-1) | ||
Summary | True | ||
Mappings |
| ||
ProcedureRequest.context | |||
Short | Encounter or Episode during which request was created | ||
Definition | An encounter or episode of care that provides additional information about the healthcare context in which this request is made. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-GPC-Encounter-1) | ||
Summary | True | ||
Alias | encounter | ||
Mappings |
| ||
ProcedureRequest.occurrence[x] | |||
Short | When procedure should occur | ||
Definition | The date/time at which the diagnostic testing should occur. | ||
Cardinality | 0..1 | ||
Type | dateTime, Period, Timing | ||
Summary | True | ||
Alias | schedule | ||
Mappings |
| ||
ProcedureRequest.asNeeded[x] | |||
Short | Preconditions for procedure or diagnostic | ||
Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc. | ||
Cardinality | 0..1 | ||
Type | boolean, CodeableConcept | ||
Binding | A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | ||
Summary | True | ||
Mappings |
| ||
ProcedureRequest.authoredOn | |||
Short | Date request signed | ||
Definition | When the request transitioned to being actionable. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Alias | orderedOn | ||
Mappings |
| ||
ProcedureRequest.requester | |||
Short | Reference to the resource for the practitioner or organization that created the ProcedureRequest. | ||
Definition | The individual who initiated the request and has responsibility for its activation. | ||
Cardinality | 0..1 | ||
Type | BackboneElement | ||
Must Support | True | ||
Summary | True | ||
Alias | author, orderer | ||
Comments | This not the dispatcher, but rather who is the authorizer. | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.requester.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.requester.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.requester.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, user content, modifiers | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.requester.agent | |||
Short | Individual making the request | ||
Definition | The device, practitioner or organization who initiated the request. | ||
Cardinality | 1..1 | ||
Type | Reference(Device | CareConnect-GPC-Organization-1 | CareConnect-GPC-Practitioner-1) | ||
Summary | True | ||
Mappings |
| ||
ProcedureRequest.requester.onBehalfOf | |||
Short | Organization agent is acting for | ||
Definition | The organization the device or practitioner was acting on behalf of. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Organization-1) | ||
Summary | True | ||
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. | ||
Mappings |
| ||
ProcedureRequest.performerType | |||
Short | Performer role | ||
Definition | Desired type of performer for doing the diagnostic testing. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||
Summary | True | ||
Comments | this is a role, not a participation type. I.e. does not describe the task, but describes the capacity. For example, “compounding pharmacy” or “psychiatrist” or “internal referral”. | ||
Mappings |
| ||
ProcedureRequest.performer | |||
Short | Reference to the resource for the practitioner or organization that is requested to perform this request the ProcedureRequest. | ||
Definition | The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Organization-1 | CareConnect-GPC-Practitioner-1) | ||
Must Support | True | ||
Summary | True | ||
Comments | If needed, use an extension for listing alternative performers and/or roles and/or preference. | ||
Mappings |
| ||
ProcedureRequest.reasonCode | |||
Short | An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. | ||
Definition | An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | Diagnosis or problem codes justifying the reason for requesting the procedure or diagnostic investigation. | ||
Must Support | True | ||
Summary | True | ||
Comments | This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all. Use CodeableConcept text element if the data is free (uncoded) text as shown in the CT Scan example. | ||
Mappings |
| ||
ProcedureRequest.reasonCode.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.reasonCode.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | 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. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId | |||
Short | The SNOMED CT Description ID | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | descriptionId | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId | |||
Short | The SNOMED CT Description ID | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | id | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay | |||
Short | The SNOMED CT display for the description ID | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | descriptionDisplay | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString | |||
Short | The SNOMED CT display for the description ID | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..0 | ||
Type | Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously. | ||
Auto Value | http://snomed.info/sct | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
Definition | The 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. | ||
Cardinality | 0..0 | ||
Type | string | ||
Summary | True | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A 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). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
ProcedureRequest.reasonCode.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | 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. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.reasonCode.text | |||
Short | Plain text representation of the concept | ||
Definition | A 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | 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. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
ProcedureRequest.reasonReference | |||
Short | A reference to any conditions the patient has that are supplied by the requesting health care professional due to their relevance to the test request. | ||
Definition | Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation. | ||
Cardinality | 0..* | ||
Type | Reference(CareConnect-GPC-Condition-1 | CareConnect-GPC-Observation-1) | ||
Must Support | True | ||
Summary | True | ||
Comments | This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all. Use CodeableConcept text element if the data is free (uncoded) text as shown in the CT Scan example. | ||
Mappings |
| ||
ProcedureRequest.supportingInfo | |||
Short | Additional clinical information | ||
Definition | Additional clinical information about the patient or specimen that may influence the procedure or diagnostics 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. | ||
Cardinality | 0..* | ||
Type | Reference(Resource | CareConnect-GPC-Observation-1) | ||
Alias | Ask at order entry question, AOE | ||
Mappings |
| ||
ProcedureRequest.specimen | |||
Short | Procedure Samples | ||
Definition | One or more specimens that the laboratory procedure will use. | ||
Cardinality | 0..* | ||
Type | Reference(CareConnect-GPC-Specimen-1) | ||
Summary | True | ||
Comments | 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, The Specimen resource references to the ProcedureRequest. | ||
Mappings |
| ||
ProcedureRequest.bodySite | |||
Short | Location on Body | ||
Definition | Anatomic location where the procedure should be performed. This is the target site. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | Codes describing anatomical locations. May include laterality. | ||
Summary | True | ||
Alias | location | ||
Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible. | ||
Comments | Only used if not implicit in the code found in ProcedureRequest.type. 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 procedurerequest-targetBodySite. | ||
Mappings |
| ||
ProcedureRequest.bodySite.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.bodySite.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | 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. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Binding | A code from the SNOMED Clinical Terminology UK with the expression (<<442083009 |anatomical or acquired body structure|). | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId | |||
Short | The SNOMED CT Description ID | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | descriptionId | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId | |||
Short | The SNOMED CT Description ID | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | id | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay | |||
Short | The SNOMED CT display for the description ID | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 1..1 | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | Note that FHIR strings may not exceed 1MB in size | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | descriptionDisplay | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString | |||
Short | The SNOMED CT display for the description ID | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..1 | ||
Type | string | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Auto Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||
Cardinality | 0..0 | ||
Type | Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing | ||
Comments | A stream of bytes, base64 encoded | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | 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 de-reference to some definition that establish the system clearly and unambiguously. | ||
Auto Value | http://snomed.info/sct | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
Definition | The 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. | ||
Cardinality | 0..0 | ||
Type | string | ||
Summary | True | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A 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). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
ProcedureRequest.bodySite.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | 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. | ||
Comments | 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. | ||
Mappings |
| ||
ProcedureRequest.bodySite.text | |||
Short | Plain text representation of the concept | ||
Definition | A 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | 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. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
ProcedureRequest.note | |||
Short | A human readable explanation from the requesting health care professional containing an explanation on why the test has been requested and any contextual information they considered relevant. | ||
Definition | Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Must Support | True | ||
Mappings |
| ||
ProcedureRequest.note.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.note.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
ProcedureRequest.note.author[x] | |||
Short | Individual responsible for the annotation | ||
Definition | The individual responsible for making the annotation. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1 | CareConnect-RelatedPerson-1), string | ||
Summary | True | ||
Mappings |
| ||
ProcedureRequest.note.time | |||
Short | When the annotation was made | ||
Definition | Indicates when this particular annotation was made. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
ProcedureRequest.note.text | |||
Short | The annotation - text content | ||
Definition | The text of the annotation. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
| ||
ProcedureRequest.relevantHistory | |||
Short | Request provenance | ||
Definition | Key events in the history of the request. | ||
Cardinality | 0..* | ||
Type | Reference(Provenance) | ||
Comments | This may 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. | ||
Mappings |
|
Background
TheProcedureRequest
profile is used for both investigations and dairy entries. Where applicable, any differences in how the element is used and populated is highlighted in the guidance below.
Element | Use | CareConnect (STU3) | UK Core (R4) |
---|---|---|---|
id | |||
meta.versionId | |||
meta.lastUpdated | |||
meta.profile | |||
meta.security | |||
meta.tag | |||
identifier | |||
definition | |||
basedOn | |||
replaces | |||
requisition | |||
status | |||
intent | |||
priority | |||
category | |||
intent | |||
context | |||
occurrence[x] | |||
asNeeded[x] | |||
authoredOn | |||
requester | |||
performerType | |||
performer | |||
reasonCode | |||
reasonReference | |||
supportingInfo | |||
specimen | |||
note |
id
Usage
MandatoryGuidance
Theid
is the logical identifier for the CareConnect-GPC-ProcedureRequest-1
profile.Example
<id value="567f2acc-b015-4d70-adde-fe15c5d3ab09" />
meta.versionId
Usage
OptionalGuidance
A use-case for themeta.versionId
element within GP Connect has not been defined.Example
<meta> <versionId value="1" /> </meta>
meta.lastUpdated
Usage
OptionalGuidance
Themeta.lastUpdated
element could be useful alongside the meta.versionId
element could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.Example
<meta> <lastUpdated value="2022-10-28T08:06:00+00:00" /> </meta>
meta.profile
Usage
MandatoryGuidance
Themeta.profile
contains a fixed value of the URL for the CareConnect-GPC-ProcedureRequest-1
profile.Example
<meta> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProcedureRequest-1" /> </meta>
meta.security
Usage
OptionalGuidance
The security label(s) applicable to the resource.See Resources not to be disclosed to a patient for more details on how to populate the element.Example
<meta> <security> <system value="http://hl7.org/fhir/v3/ActCode"/> <code value="NOPAT"/> <display value="no disclosure to patient, family or caregivers without attending provider's authorization"/> </security> </meta>
meta.tag
Usage
OptionalGuidance
A use-case for themeta.tag
element within GP Connect has not been defined.Example
<meta> <tag> <coding> <system value="http://hl7.org/fhir/common-tags" /> <code value="actionable" /> <display value="Actionable" /> </coding> </tag> </meta>
identifier
Usage
MandatoryGuidance
Theidentifier
element MUST be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This MUST be scoped by a provider specific namespace for the identifier.Where consuming systems are integrating data from this resource to their local system, they MUST also persist this identifier at the same time.Example
<identifier> <system value="https://foo.bar/id/procedure-request" /> <value value="5e19e7a4-686b-4a6e-9530-8d7406d3b172" /> </identifier>
definition
Usage
OptionalGuidance
A use-case for thedefinition
element within GP Connect has not been defined.Example
<definition> <reference value="plan-definition--00192ast" /> </definition>
basedOn
Usage
OptionalGuidance
A use-case for thebasedOn
element within GP Connect has not been defined.Example
<basedOn> <reference value="resource--00100hat" /> </basedOn>
replaces
Usage
OptionalGuidance
A use-case for thereplaces
element within GP Connect has not been defined.Example
<replaces> <reference value="resource--00yir83" /> </reaplces>
requisition
Usage
OptionalGuidance
Therequisition
element does not need to be populated.Example
<requisition> <use value="official" /> <type value="VN" /> <system value="https://foo.bar/id/requisition" /> <value value="42068246-fbbb-44e8-825d-91f091273263" /> <period> <start value="2022-11-01T00:00:00Z" /> <end value="2022-11-04T00:00:00Z" /> </period> <assigner> <reference> <identifier> <system value="https://fhir.nhs.uk/Id/sds-user-id"/> <value value="UNK"/> </identifier> </reference> <assigner> </requisition>
status
Usage
MandatoryGuidance
The status of the ProcedureRequest.The status MUST only beactive
. Code System Request StatusFor investigations:
This is mandatory in the base FHIR resource. However, as this resource is not being used as a request but to hold data that would have been in a request submitted in a different format we have chosen to use the default value stated.For diary entries
The provider MUST only include incomplete diary entries - that is, complete or cancelled MUST NOT be included.Example
<status value="active" />
intent
Usage
MandatoryGuidance
The status of theProcedureRequest
. Code System Request IntentFor investigations:
Theintent
MUST only be order
.Example
<intent value="order" />
For diary entries
Theintent
MUST only be plan
.Example
<intent value="plan" />
priority
Usage
OptionalGuidance
A use case for thepriority
element within GP Connect has not been defined.Example
<priority value="stat" />
doNotPerform
Usage
OptionalGuidance
A use-case for thedoNotPerform
element within GP Connect has not been defined.Example
<doNotPerform value="true" />
category
Usage
OptionalGuidance
Classification of the procedure Binding (example): A code that classifies a procedure for searching, sorting and display purposes. ( http://hl7.org/fhir/stu3/valueset-procedure-category.html )Example
<category> <coding> <system value="http://snomed.info/sct" /> <code value="83474000" /> <display value="Psychiatric commitment procedure (procedure)" /> <snomedCT> <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" /> <extension> <valueId value="83474000" /> <descriptionId value="83474000" /> <descriptionDisplay value="Psychiatric commitment procedure (procedure)" /> </extesion> </snomedCT> </coding> <text value="Psychiatric commitment procedure (procedure)" /> </category>
code
Usage
MandatoryGuidance
For investigations:
Thecode
element can be used to represent the tests requested by the requesting healthcare professional.In the event of a code not being available, providers MUST populate the code.text
field with the text No code available
.Example
<code> <coding> <system value="http://snomed.info/sct" /> <code value="8941001000001100" /> <display value="Not available (qualifier value)" /> <snomedCT> <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" /> <extension> <valueId value="8941001000001100" /> <descriptionId value="8941001000001100" /> <descriptionDisplay value="Not available (qualifier value)" /> </extesion> </snomedCT> </coding> <text value="No code available" /> </code>
For diary entries
The planned event, action or activity.Example
<code> <coding> <system value="http://snomed.info/sct" /> <code value="408490001" /> <display value="Antipsychotic drug therapy" /> </coding> <text value="No code available" /> </code>
subject
Usage
MandatoryGuidance
Thesubject
element will contain a reference to the Patient that the ProcedureRequest
is regarding. This can either be as a reference within the payload, or using the reference.identifier
.Example
<subject> <extension> <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1" /> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1" /> <code value="01" /> <display value="Number present and verified" /> </coding> <!-- text optional as already stipulated within the codeable concept --> <text value="Number present and verified" /> </valueCodeableConcept> </extension> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="4857773456" /> </subject>
context
Usage
OptionalGuidance
For investigations
A use-case for thecontext
element has not been defined.For diary entries
A reference to the consultation from which the diary entry originates - that is, the consultation which the diary entry was created within.Example
<context> <reference value="encounter--episode-of-care--00123sal" /> </context>
occurrence[x]
Usage
OptionalGuidance
For investigations
A use-case for theoccurrence[x]
element has not been defined.For diary entries
The date or date range when the diary entry is planned to occur.Example
<occurrenceDateTime value="2022-12-09T12:50:00Z" />
asNeeded[x]
Usage
OptionalGuidance
A use-case for theasNeeded[x]
element within GP Connect has not been defined.Example
<asNeededBoolean value="false" />
<category> <coding> <system value="http://snomed.info/sct" /> <code value="171008" /> <display value="Injury of ascending right colon without open wound into abdominal cavity" /> <snomedCT> <url value="https://hl7.org/fhir/valueset-medication-as-needed-reason.html" /> </snomedCT> </coding> <text value="Injury of ascending right colon without open wound into abdominal cavity"> </category>
requester
Usage
For investigations
RequiredFor diary entries
MandatoryGuidance
For investigations
Reference to the resource for the practitioner or organization that created the ProcedureRequest.For diary entries
The person or system who entered the diary entry into the original source system.Example
<requester> <reference> <identifier> <system value="https://fhir.hl7.org.uk/Id/gmc-number" /> <value value="000000000" /> <display value="Test GP" /> </identifier> </reference> </requester>
requester.agent
Usage
For investigations
OptionalFor diary entries
RequiredGuidance
For investigations
A use-case for therequester.agent
element has not been defined.For diary entries
This MUST be the practitioner who entered the diary entry in the original source system, if it was entered by a user. If the diary entry was system generated and it is not possible to meaningfully associate the diary entry to a system user then this MUST be aDevice
representing the providing system or an Organization
representing the GP practice responsible for creating the record.Example
<requester> <agent> <reference value="Practitioner/6c41ebfd-57c3-4162-9d7b-208c171a2fd7" /> </agent> </requester>
performerType
Usage
OptionalGuidance
A use-case for theperformerType
element within GP Connect has not been defined.Example
<performerType> <system value="http://snomed.info/sct" /> <code value="125676002" /> <display value="Person" /> </performerType>
performer
Usage
For investigations
RequiredFor diary entries
OptionalGuidance
For investigations
Reference to the resource for the practitioner or organization that is requested to perform this request the ProcedureRequest.Example
<performer> <reference> <identifier> <system value="https://fhir.hl7.org.uk/Id/gmc-number" /> <value value="000000000" /> <display value="Test GP" /> </identifier> </reference> </performer>
For diary entries
A use-case for theperformer
element has not been defined.reasonCode
Usage
For investigations
RequiredFor diary entries
OptionalGuidance
For investigations
An explanation or justification for why this diagnostic investigation is being requested in coded or textual form.For diary entries
The reason the action recorded in the diary entry is needed. This is the trigger reason for the diary entry not the action of the diary entry.Example
<reasonCode> <coding> <system value="http://snomed.info/sct" /> <code value="123823007" /> <display value="Decreased blood oxygen pressure (finding)" /> <snomedCT> <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" /> <extension> <valueId value="123823007" /> <descriptionId value="123823007" /> <descriptionDisplay value="Decreased blood oxygen pressure (finding)" /> </extesion> </snomedCT> </coding> <text value="Decreased blood oxygen pressure (finding)" /> </reasonCode>
reasonReference
Usage
For investigations
RequiredFor diary entries
OptionalGuidance
For investigations
A reference to any conditions the patient has that are supplied by the requesting healthcare professional due to their relevance to the test request.For diary entries
A diary entry may have a linked problem which represents the reason for the diary entry. This is required information where it exists, but the problem MUST be included and reference the diary entry. The diary entry MUST NOT reference to the problem.Example
<reasonReference> <reference value="condition-00t29s" /> </reasonReference>
supportingInfo
Usage
OptionalGuidance
For investigations
A use-case for thesupportingInfo
element has not been defined.For diary entries
Additional clinical information linked to the diary entry MAY be included, except a linked problem which MUST be included in the bundle as a Profile: CareConnect-GPC-ProblemHeader-Condition-1 which references the diary entry, not vice versa.A document MAY be linked through a reference to theResource
.Example
<supportingInfo> <reference value="observation-001sdk345" /> </supportingInfo>
specimen
Usage
OptionalGuidance
A use-case for thespecimen
element within GP Connect has not been defined.Example
<specimen> <reference value="specimen-001sdk345" /> </specimen>
bodySite
Usage
OptionalGuidance
A use-case for thebodySite
element within GP Connect has not been defined.Example
<bodySite> <coding> <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1" /> <code value="182169008" /> <display value="Entire elbow joint (body structure)" /> </coding> </bodySite>
note
Usage
RequiredGuidance
For investigations
A human readable explanation from the requesting healthcare professional containing an explanation on why the test has been requested and any contextual information they considered relevant.For diary entries
Free text narrative to describe the reason for the diary entry or the action / activity required by the diary entry. This is for additional content beyond thecode
and reasonCode
coded elements and is not intended to duplicate the content of those elements.Example
<note> <author> <reference value="practitioner-948392" /> </author> <time value="2022-10-13T16:59:00Z" /> <text> Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM). </text> </note>
relevantHistory
Usage
OptionalGuidance
For investigations
Key events in the history of the request.For diary entries
Additional clinical information linked to the diary entry MAY be included, except a linked problem which MUST be included in the bundle as a Profile: CareConnect-GPC-ProblemHeader-Condition-1 which references the diary entry, not vice versa.A document MAY be linked through a reference to theResource
.Example
<supportingInfo> <reference value="observation-001sdk345" /> </supportingInfo>
relevantHistory
Usage
OptionalGuidance
Key events in the history of the request.Example
<reasonReference> <reference value="provenance--00y1pa2" /> </reasonReference>