Profile: CareConnect-GPC-Immunization-1
CareConnect-GPC-Immunization-1 (Immunization) | C | Immunization | |
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 | |
parentPresent | S C | 0..1 | Extension(boolean) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueBoolean | 1..1 | boolean | |
recordedDate | C | 1..1 | Extension(dateTime) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueDateTime | 1..1 | dateTime | |
vaccinationProcedure | C | 1..1 | Extension(CodeableConcept) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
url | 1..1 | uriAuto Value | |
valueCodeableConcept | 1..1 | CodeableConceptBinding | |
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(CareConnect-GPC-Organization-1) |
status | Σ ?! | 1..1 | codeBindingAuto Value |
notGiven | Σ ?! | 1..1 | boolean |
vaccineCode | 1..1 | CodeableConceptBinding | |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
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 |
patient | 1..1 | Reference(CareConnect-GPC-Patient-1) | |
encounter | S | 0..1 | Reference(CareConnect-Encounter-1) |
date | S | 0..1 | dateTime |
primarySource | 1..1 | boolean | |
reportOrigin | S | 0..1 | CodeableConcept |
location | S | 0..1 | Reference(CareConnect-GPC-Location-1) |
manufacturer | S | 0..1 | Reference(CareConnect-GPC-Organization-1) |
lotNumber | S | 0..1 | string |
expirationDate | S | 0..1 | date |
site | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | 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..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
route | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | 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..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
doseQuantity | S | 0..1 | SimpleQuantity |
practitioner | S Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
role | S Σ | 0..1 | CodeableConceptBinding |
actor | Σ | 1..1 | Reference(CareConnect-GPC-Practitioner-1) |
note | S Σ | 0..* | Annotation |
id | 0..1 | string | |
extension | 0..* | Extension | |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference(RelatedPerson | CareConnect-GPC-Practitioner-1 | CareConnect-GPC-Patient-1) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string | |
explanation | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
reason | S | 0..* | CodeableConcept |
reasonNotGiven | S | 0..* | CodeableConceptBinding |
reaction | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
date | 0..1 | dateTime | |
detail | 0..1 | Reference(CareConnect-GPC-Observation-1) | |
reported | 0..1 | boolean | |
vaccinationProtocol | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
doseSequence | 1..1 | positiveInt | |
description | S | 0..1 | string |
authority | 0..1 | Reference(CareConnect-GPC-Organization-1) | |
series | 0..1 | string | |
seriesDoses | S | 0..1 | positiveInt |
targetDisease | 1..* | CodeableConcept | |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | 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..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
doseStatus | 1..1 | CodeableConcept | |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | codeAuto Value |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
doseStatusReason | 0..1 | CodeableConcept |
Immunization | |||
Short | Immunization event information | ||
Definition | Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed. | ||
Cardinality | 0..* | ||
Constraints |
| ||
Mappings |
| ||
Immunization.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. | ||
Immunization.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 | ||
Immunization.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 |
| ||
Immunization.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 |
| ||
Immunization.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. | ||
Immunization.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. | ||
Immunization.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. | ||
Immunization.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. | ||
Immunization.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. | ||
Immunization.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. | ||
Immunization.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). | ||
Immunization.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 |
| ||
Immunization.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 |
| ||
Immunization.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. | ||
Slicing | Unordered, Open, by url(Value) | ||
Mappings |
| ||
Immunization.extension:parentPresent | |||
Short | Was a parent present at the Immunization | ||
Definition | Was a parent present at the Immunization. | ||
Cardinality | 0..1 | ||
Type | Extension(boolean) | ||
Must Support | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Immunization.extension:parentPresent.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 |
| ||
Immunization.extension:parentPresent.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 |
| ||
Immunization.extension:parentPresent.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-CareConnect-ParentPresent-1 | ||
Mappings |
| ||
Immunization.extension:parentPresent.value[x]:valueBoolean | |||
Short | Was a parent present at the Immunization | ||
Definition | Was a parent present at the Immunization. | ||
Cardinality | 1..1 | ||
Type | boolean | ||
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 |
| ||
Immunization.extension:recordedDate | |||
Short | The date that the Vaccination was recorded | ||
Definition | The date that the event was recorded on the system. | ||
Cardinality | 1..1 | ||
Type | Extension(dateTime) | ||
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 |
| ||
Immunization.extension:recordedDate.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 |
| ||
Immunization.extension:recordedDate.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 |
| ||
Immunization.extension:recordedDate.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-CareConnect-DateRecorded-1 | ||
Mappings |
| ||
Immunization.extension:recordedDate.value[x]:valueDateTime | |||
Short | The date that the event was recorded | ||
Definition | The date that the event was recorded. | ||
Cardinality | 1..1 | ||
Type | dateTime | ||
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 |
| ||
Immunization.extension:vaccinationProcedure | |||
Short | The procedure code describing the vaccine that was administered. | ||
Definition | An extension to hold an immunization procedure code. | ||
Cardinality | 1..1 | ||
Type | Extension(CodeableConcept) | ||
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 |
| ||
Immunization.extension:vaccinationProcedure.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 |
| ||
Immunization.extension:vaccinationProcedure.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 |
| ||
Immunization.extension:vaccinationProcedure.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-CareConnect-VaccinationProcedure-1 | ||
Mappings |
| ||
Immunization.extension:vaccinationProcedure.valueCodeableConcept:valueCodeableConcept | |||
Short | A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure. | ||
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 | 1..1 | ||
Type | CodeableConcept | ||
Binding | A code from SNOMED Clinical Terminology UK | ||
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 |
| ||
Immunization.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 |
| ||
Immunization.identifier | |||
Short | Business identifier | ||
Definition | A unique identifier assigned to this immunization record. | ||
Cardinality | 1..* | ||
Type | Identifier | ||
Mappings |
| ||
Immunization.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 |
| ||
Immunization.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 |
| ||
Immunization.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 |
| ||
Immunization.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 |
| ||
Immunization.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 |
| ||
Immunization.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 |
| ||
Immunization.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 |
| ||
Immunization.identifier.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 |
| ||
Immunization.status | |||
Short | completed | ||
Definition | Indicates the current status of the vaccination event. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | A set of codes indicating the current status of an Immunization | ||
Modifier | True | ||
Summary | True | ||
Comments | Will generally be set to show that the immunization has been completed. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||
Auto Value | completed | ||
Mappings |
| ||
Immunization.notGiven | |||
Short | Flag for whether immunization was given | ||
Definition | Indicates if the vaccination was or was not given. | ||
Cardinality | 1..1 | ||
Type | boolean | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because it indicates that an immunization didn't happen. | ||
Mappings |
| ||
Immunization.vaccineCode | |||
Short | Vaccine product administered | ||
Definition | Vaccine that was administered or was to be administered. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | The code for vaccine product administered | ||
Mappings |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.vaccineCode.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 |
| ||
Immunization.patient | |||
Short | Who was immunized | ||
Definition | The patient who either received or did not receive the immunization. | ||
Cardinality | 1..1 | ||
Type | Reference(CareConnect-GPC-Patient-1) | ||
Mappings |
| ||
Immunization.encounter | |||
Short | Encounter administered as part of | ||
Definition | The visit or admission or other contact between patient and health care provider the immunization was performed as part of. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-Encounter-1) | ||
Must Support | True | ||
Mappings |
| ||
Immunization.date | |||
Short | Vaccination administration date | ||
Definition | Date vaccine administered or was to be administered. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Must Support | True | ||
Comments | When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. | ||
Mappings |
| ||
Immunization.primarySource | |||
Short | Indicates context the data was recorded in | ||
Definition | An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded. | ||
Cardinality | 1..1 | ||
Type | boolean | ||
Comments | Reflects the “reliability” of the content. | ||
Default value | true | ||
Mappings |
| ||
Immunization.reportOrigin | |||
Short | Indicates the source of a secondarily reported record | ||
Definition | The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The source of the data for a record which is not from a primary source. | ||
Must Support | True | ||
Comments | Should not be populated if primarySource = True, will not be required even if primarySource = False. | ||
Mappings |
| ||
Immunization.location | |||
Short | Where vaccination occurred | ||
Definition | The service delivery location where the vaccine administration occurred. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Location-1) | ||
Must Support | True | ||
Mappings |
| ||
Immunization.manufacturer | |||
Short | Vaccine manufacturer | ||
Definition | Name of vaccine manufacturer. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Organization-1) | ||
Must Support | True | ||
Mappings |
| ||
Immunization.lotNumber | |||
Short | Vaccine lot number | ||
Definition | Lot number of the vaccine product. | ||
Cardinality | 0..1 | ||
Type | string | ||
Must Support | True | ||
Mappings |
| ||
Immunization.expirationDate | |||
Short | Vaccine expiration date | ||
Definition | Date vaccine batch expires. | ||
Cardinality | 0..1 | ||
Type | date | ||
Must Support | True | ||
Mappings |
| ||
Immunization.site | |||
Short | Body site vaccine was administered | ||
Definition | Body site where vaccine was administered. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The site at which the vaccine was administered | ||
Must Support | True | ||
Mappings |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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..1 | ||
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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.site.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 |
| ||
Immunization.route | |||
Short | How vaccine entered body | ||
Definition | The path by which the vaccine product is taken into the body. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The route by which the vaccine was administered | ||
Must Support | True | ||
Mappings |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
Type | Coding | ||
Binding | A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. | ||
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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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..1 | ||
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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.route.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 |
| ||
Immunization.doseQuantity | |||
Short | Amount of vaccine administered | ||
Definition | The quantity of vaccine product that was administered. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Must Support | True | ||
Mappings |
| ||
Immunization.practitioner | |||
Short | Who performed event | ||
Definition | Indicates who or what performed the event. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Must Support | True | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Immunization.practitioner.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 |
| ||
Immunization.practitioner.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 |
| ||
Immunization.practitioner.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 |
| ||
Immunization.practitioner.role | |||
Short | What type of performance was done | ||
Definition | Describes the type of performance (e.g. ordering provider, administering provider, etc.). | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The role a practitioner plays in the immunization event | ||
Must Support | True | ||
Summary | True | ||
Mappings |
| ||
Immunization.practitioner.actor | |||
Short | Individual who was performing | ||
Definition | The device, practitioner, etc. who performed the action. | ||
Cardinality | 1..1 | ||
Type | Reference(CareConnect-GPC-Practitioner-1) | ||
Summary | True | ||
Mappings |
| ||
Immunization.note | |||
Short | Vaccination notes | ||
Definition | Extra information about the immunization that is not conveyed by the other attributes. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Must Support | True | ||
Summary | True | ||
Mappings |
| ||
Immunization.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 |
| ||
Immunization.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 |
| ||
Immunization.note.author[x] | |||
Short | Individual responsible for the annotation | ||
Definition | The individual responsible for making the annotation. | ||
Cardinality | 0..1 | ||
Type | Reference(RelatedPerson | CareConnect-GPC-Practitioner-1 | CareConnect-GPC-Patient-1), string | ||
Summary | True | ||
Mappings |
| ||
Immunization.note.time | |||
Short | When the annotation was made | ||
Definition | Indicates when this particular annotation was made. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
Immunization.note.text | |||
Short | The annotation - text content | ||
Definition | The text of the annotation. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
| ||
Immunization.explanation | |||
Short | Administration/non-administration reasons | ||
Definition | Reasons why a vaccine was or was not administered. | ||
Cardinality | 0..1 | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
Immunization.explanation.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 |
| ||
Immunization.explanation.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 |
| ||
Immunization.explanation.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 |
| ||
Immunization.explanation.reason | |||
Short | Why immunization occurred | ||
Definition | Reasons why a vaccine was administered. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | The reason why a vaccine was administered | ||
Must Support | True | ||
Mappings |
| ||
Immunization.explanation.reasonNotGiven | |||
Short | Why immunization did not occur | ||
Definition | Reason why a vaccine was not administered. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | The reason why a vaccine was not administered Care Connect Reason Immunization Not Administered (extensible) | ||
Must Support | True | ||
Mappings |
| ||
Immunization.reaction | |||
Short | Details of a reaction that follows immunization | ||
Definition | Categorical data indicating that an adverse event is associated in time to an immunization. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Comments | A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements. | ||
Constraints |
| ||
Mappings |
| ||
Immunization.reaction.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 |
| ||
Immunization.reaction.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 |
| ||
Immunization.reaction.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 |
| ||
Immunization.reaction.date | |||
Short | When reaction started | ||
Definition | Date of reaction to the immunization. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Mappings |
| ||
Immunization.reaction.detail | |||
Short | Additional information on reaction | ||
Definition | Details of the reaction. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Observation-1) | ||
Mappings |
| ||
Immunization.reaction.reported | |||
Short | Indicates self-reported reaction | ||
Definition | Self-reported indicator. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Mappings |
| ||
Immunization.vaccinationProtocol | |||
Short | What protocol was followed | ||
Definition | Contains information about the protocol(s) under which the vaccine was administered. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
Immunization.vaccinationProtocol.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 |
| ||
Immunization.vaccinationProtocol.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 |
| ||
Immunization.vaccinationProtocol.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 |
| ||
Immunization.vaccinationProtocol.doseSequence | |||
Short | Dose number within series | ||
Definition | Nominal position in a series. | ||
Cardinality | 1..1 | ||
Type | positiveInt | ||
Mappings |
| ||
Immunization.vaccinationProtocol.description | |||
Short | Details of vaccine protocol | ||
Definition | Contains the description about the protocol under which the vaccine was administered. | ||
Cardinality | 0..1 | ||
Type | string | ||
Must Support | True | ||
Mappings |
| ||
Immunization.vaccinationProtocol.authority | |||
Short | Who is responsible for protocol | ||
Definition | Indicates the authority who published the protocol. E.g. ACIP. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-GPC-Organization-1) | ||
Mappings |
| ||
Immunization.vaccinationProtocol.series | |||
Short | Name of vaccine series | ||
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Immunization.vaccinationProtocol.seriesDoses | |||
Short | Recommended number of doses for immunity | ||
Definition | The recommended number of doses to achieve immunity. | ||
Cardinality | 0..1 | ||
Type | positiveInt | ||
Must Support | True | ||
Mappings |
| ||
Immunization.vaccinationProtocol.targetDisease | |||
Short | Disease immunized against | ||
Definition | The targeted disease. | ||
Cardinality | 1..* | ||
Type | CodeableConcept | ||
Binding | The disease target of the vaccination protocol | ||
Mappings |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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..1 | ||
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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.targetDisease.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 |
| ||
Immunization.vaccinationProtocol.doseStatus | |||
Short | Indicates if dose counts towards immunity | ||
Definition | Indicates if the immunization event should "count" against the protocol. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | The status of the vaccination protocol (i.e. should this count) | ||
Comments | May need to differentiate between status declarations by a provider vs. a CDS engine. | ||
Mappings |
| ||
Immunization.vaccinationProtocol.doseStatus.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 |
| ||
Immunization.vaccinationProtocol.doseStatus.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 |
| ||
Immunization.vaccinationProtocol.doseStatus.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. | ||
Mappings |
| ||
Immunization.vaccinationProtocol.doseStatus.coding.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 |
| ||
Immunization.vaccinationProtocol.doseStatus.coding.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 |
| ||
Immunization.vaccinationProtocol.doseStatus.coding.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. | ||
Mappings |
| ||
Immunization.vaccinationProtocol.doseStatus.coding.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..1 | ||
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 |
| ||
Immunization.vaccinationProtocol.doseStatus.coding.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. | ||
Auto Value | count | ||
Mappings |
| ||
Immunization.vaccinationProtocol.doseStatus.coding.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 |
| ||
Immunization.vaccinationProtocol.doseStatus.coding.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 |
| ||
Immunization.vaccinationProtocol.doseStatus.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 |
| ||
Immunization.vaccinationProtocol.doseStatusReason | |||
Short | Why dose does (not) count | ||
Definition | Provides an explanation as to why an immunization event should or should not count against the protocol. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The reason for the determining if a vaccination should count or why vaccination should not count. | ||
Mappings |
|
Data model element usage
Element | Use | CareConnect (STU3) | UK Core (R4) | NHS Digital (R4) |
---|---|---|---|---|
id | ||||
meta.versionId | ||||
meta.lastUpdated | ||||
meta.profile | ||||
meta.security | ||||
meta.tag | ||||
extension(parentPresent) | ||||
extension(recordedDate) | ||||
extension(vaccinationProcedure) | ||||
identifier | ||||
status | ||||
notGiven | ||||
vaccineCode | ||||
patient | ||||
encounter | ||||
date | ||||
primarySource | ||||
reportOrigin | ||||
location | ||||
manufacturer | ||||
lotNumber | ||||
expirationDate | ||||
site | ||||
route | ||||
doseQuantity | ||||
practitioner.role | ||||
practitioner.actor | ||||
note | ||||
explanation.reason | ||||
explanation.reasonNotGiven | ||||
reaction | ||||
vaccinationProtocol | ||||
vaccinationProtocol.doseSequence | ||||
vaccinationProtocol.description | ||||
vaccinationProtocol.authority | ||||
vaccinationProtocol.series | ||||
vaccinationProtocol.seriesDoses | ||||
vaccinationProtocol.targetDisease | ||||
vaccinationProtocol.doseStatus | ||||
vaccinationProtocol.doseStatusReason |
id
Usage
Optional
Guidance
The id
is the logical identifier for the CareConnect-GPC-Immunization-1
profile.
Example
<id value="3d86f348-4e1d-11ed-bdc3-0242ac120002" />
meta.versionId
Usage
Optional
Guidance
The population of 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> <versionId value="1" /> </meta>
meta.lastUpdated
Usage
Optional
Guidance
The meta.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
Mandatory
Guidance
The meta.profile
contains a fixed value of the URL for the CareConnect-GPC-Immunization-1
profile.
Example
<meta> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Immunization-1" /> </meta>
meta.security
Usage
Optional
Guidance
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
Optional
Guidance
A use-case for the meta.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>
extension(parentPresent)
Usage
Required
Guidance
Indicates whether a parent was present at the immunisation.
Example
<extension> <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1" /> <valueBoolean value="true" /> </extension>
extension(recordedDate)
Usage
Mandatory
Guidance
This is the date the immunisation record (given or not given) was entered on the clinical system. This may be an audit trail date or equivalent for the record. If the immunisation has been transferred by GP2GP this SHOULD be the recorded date from the original record entry from the originating system.
Example
<extension> <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1" /> <valueDateTime value="2022-10-17T14:21:00Z" /> </extension>
extension(vaccinationProcedure)
Usage
Mandatory
Guidance
The procedure code describing the vaccine that was administered or the situation code for a vaccination that was intended to be administered but was not done. See the profile for the valid codes.
Example
<extension> <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1" /> <valueCodeableConcept> <coding> <system value="http://snomed.info/sct" /> <code value="1324681000000101" /> <display value="Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" /> </coding> </valueCodeableConcept> </extension>
identifier
Usage
Mandatory
Guidance
The identifier
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/immunization" /> <value value="a58ca801-0858-47ce-8075-2df2c73935d1" /> </identifier>
status
Usage
Mandatory
Guidance
The status
element has a fixed value of completed
for all CareConnect
profiles.
Example
<status value="completed" />
notGiven
Usage
Mandatory
Guidance
The status
element MUST contain a boolean
value:
false
indicates a vaccination event which has been reported as giventrue
indicates that a vaccination was intended; however, was not given
Example
<notGiven value="false" />
vaccineCode
Usage
Mandatory
Guidance
Vaccine product administered or intended to be administered.
Where the vaccine product that was administered is not known then the null flavour value code UNK
MUST be populated.
Example
Where the vaccine product is known.
<vaccineCode> <system value="http://snomed.info/sct" /> <code value="1119349007" /> <display value="Vaccine product containing only severe acute respiratory syndrome coronavirus 2 messenger ribonucleic acid (medicinal product)" /> </vaccineCode>
Where the vaccine product is not known.
<vaccineCode> <coding> <system value="http://hl7.org/fhir/v3/NullFlavor" /> <code value="UNK" /> <display value="Unknown" /> </vaccineCode>
patient
Usage
Mandatory
Guidance
A reference to the patient the vaccination event relates to.
Profile: CareConnect-GPC-Patient-1
Example
<patient> <reference value="patient-4857773456" /> <display value="TEAK, Anne (Mrs)" /> </patient>
encounter
Usage
Required
Guidance
The consultation within which this immunisation record was captured. This may represent when the vaccination was administered, intended to be administered or when the registered practice was informed of an immunisation administered elsewhere.
Profile: CareConnect-GPC-Encounter-1
Example
<encounter> <reference value="encounter-1234234" /> </encounter>
date
Usage
Required
Guidance
The date (and time if applicable) when the immunization was administered or intended to be administered. If the immunisation was administered elsewhere, this may be an estimated or partial date.
Example
<authoredOn value="2022-10-18T14:06:00Z" />
primarySource
Usage
Mandatory
Guidance
This indicates whether the record is based on information from the person who administered or intended to administer the vaccine.
This MUST be true where the immunisation record was recorded by the person who administered the vaccine or directly on behalf of the administrator of the vaccine (this includes recording the immunisation based on a complete, original, verifiable document from the administration of the vaccine).
This MUST be false
where it is a secondary report of a vaccination for example the recollection of the patient, the patient’s parent, carer or guardian or a secondary document.
As this relates to the context of the original source of the immunisation record, a record from a GP2GP transfer is still a primary record if it was originally recorded as primary.
If it is not known whether the record of the vaccination was made from a primary or secondary source, then return the default value of true
.
Example
<primarySource value="true" />
reportOrigin
Usage
Required
Guidance
This indicates the source of a secondary reported record.
This provides additional context to the source of the immunisation record where it is not based on information from the person who administered the vaccine. The reportOrigin
element can be absent if the record is NOT from a primary source, but the origin of the record is otherwise not recorded / known.
This MUST be absent where the primarySource
element has the value of true
.
Example
<reportOrigin> <coding> <system value="http://hl7.org/fhir/stu3/valueset-immunization-origin.html"> <code value="provider" /> <display value="Other Provider" /> </coding> </reportOrigin>
location
Usage
Required
Guidance
The GP practice, branch surgery or other location where the vaccination occurred or was intended to occur, if known.
If the immunisation record in the GP Clinical System does not record a location for the vaccination, but is linked to a consultation then
- if the vaccine was administered or was intended to be administered during the consultation the location MUST be populated with the location of the consultation
- if the vaccine was NOT administered or intended to be administered during the consultation and the location for the vaccination is therefore unknown, then a location MUST be absent
Profile: CareConnect-GPC-Location-1
Example
<location> <reference value="location-992891" /> </location>
manufacturer
Usage
Required
Guidance
The manufacturer of the vaccine.
Profile: CareConnect-GPC-Organization-1
Example
<manufacturer> <reference value="organization-29411" /> </manufacturer>
lotNumber
Usage
Required
Guidance
The batch number of the vaccine.
Example
<lotNumber value="29382/10AV" />
expirationDate
Usage
Required
Guidance
The expiry date of the batch the vaccine is from.
Example
<expirationDate value="2022-10-18T14:06:00Z" />
site
Usage
Required
Guidance
The site on the body where the vaccine was administered.
Example
<site> <coding> <system value="http://snomed.info/sct" /> <code value="368208006" /> <display value="Left upper arm structure (body structure)" /> </coding> </site>
route
Usage
Required
Guidance
The route through which the vaccine entered the body.
Example
<route> <coding> <system value="http://snomed.info/sct" /> <code value="78421000" /> <display value="Intramuscular route (qualifier value)" /> </coding> </route>
doseQuantity
Usage
Required
Guidance
The amount of the vaccine administered.
Example
<doseQuantity> <system value="http://snomed.info/sct" /> <code value="3318611000001103" /> <display value="pre-filled disposable injection (qualifier value)" /> </doseQuantity>
practitioner.role
Usage
Required
Guidance
The role of the referenced practitioner, if known, from the v2 Provider Role code system.
- The code
EP
(Entering Provider) MUST be used to designate the practitioner as having recorded the vaccination (or reason not given). - The code
AP
(Administering Provider) MUST be used to designate the practitioner as having administered the vaccination or intending to if the vaccine was not given.
Example
<practitioner> <role> <coding> <system value="http://hl7.org/fhir/v2/0443" /> <code value="AP" /> <display value="Administering Provider" /> </coding> </role> </practitioner>
practitioner.actor
Usage
Mandatory
Guidance
A reference to the practitioner who administered and / or recorded the vaccine.
Where there is only a single practitioner recorded against the immunisation record:
- if the practitioner recording the vaccination also administered it (or intended to), then associate a
practitioner.role
codeAP
(Administering Provider) with practitioner profile - if the GP Clinical System cannot determine whether the practitioner administered the vaccine or just recorded the vaccination event or both, then do not return a
practitioner.role
practitioner.role
is populated.
Profile: CareConnect-GPC-Practitioner-1
Example
<practitioner> <actor> <reference value="practitioner-9093012" /> </actor> </practitioner>
note
Usage
Required
Guidance
All notes that are associated with the vaccination event.
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>
explanation.reason
Usage
Required
Guidance
The reason why the immunization was given, for example, travel, occupation, and so on. This MUST be absent if notGiven is true.
notGiven
has the value true
.
Example
<explanation> <reason> <coding> <system value="http://snomed.info/sct" /> <code value="443684005" /> <display value="Disease outbreak" /> </coding> </reason> </explanation>
explanation.reasonNotGiven
Usage
Required
Guidance
The reason from the CareConnect Reason Immunization Not Administered value set to indicate the reason the immunization was not given.
notGiven
has the value true
.
Example
<explanation> <reasonNotGiven> <coding> <system value="http://snomed.info/sct" /> <code value="281399006" /> <display value="Did not attend (finding)" /> </coding> </reasonNotGiven> </explanation>
reaction
Usage
Optional
Guidance
Profile: CareConnect-GPC-AllergyIntolerance-1
Example
<reaction> <detail> <reference value="allergyintolerance-77492" /> </detail> </reaction>
vaccinationProtocol
Usage
Required
Guidance
The protocol for the vaccination.
notGiven
has the value of true
.
vaccinationProtocol.doseSequence
Usage
Mandatory
Guidance
If the immunisation is achieved via a series of vaccinations, this is the position of the vaccine procedure in the series.
<vaccinationProtocol> <doseSequence value="1" /> </vaccinationProtocol>
vaccinationProtocol.description
Usage
Required
Guidance
A description for the vaccination protocol this vaccination is administered under.
<vaccinationProtocol> <description value="Lorem ipsum dolor sit amet" /> </vaccinationProtocol>
vaccinationProtocol.series
Usage
Optional
Guidance
A use-case for the vaccinationProtocol.series
element within GP Connect has not been defined.
Profile: CareConnect-GPC-Organization-1
<vaccinationProtocol> <series value="Ut enim ad minim veniam" /> </vaccinationProtocol>
vaccinationProtocol.seriesDoses
Usage
Required
Guidance
The number of doses in the series which are required for vaccination given (at the time it was given / not given).
<vaccinationProtocol> <seriesDoses value="2" /> </vaccinationProtocol>
vaccinationProtocol.targetDisease
Usage
Mandatory
Guidance
The disease or diseases the patient is being immunised against.
<vaccinationProtocol> <targetDisease> <coding> <system value="http://snomed.info/sct" /> <code value="840539006" /> <display value="Disease caused by severe acute respiratory syndrome coronavirus 2 (disorder)" /> </coding> </targetDisease> </vaccinationProtocol>
vaccinationProtocol.doseStatus
Usage
Mandatory
Guidance
This element has a fixed value of count
from the Vaccination Protocol Dose Status value set
<vaccinationProtocol> <doseStatus> <coding> <system value="http://hl7.org/fhir/vaccination-protocol-dose-status" /> <code value="count" /> <display value="Counts" /> </coding> </doseStatus> </vaccinationProtocol>
vaccinationProtocol.doseStatusReason
Usage
Optional
Guidance
A use-case for the vaccinationProtocol.doseStatusReason
element within GP Connect has not been defined.
<vaccinationProtocol> <doseStatusReason> <coding> <system value="http://hl7.org/fhir/stu3/codesystem-vaccination-protocol-dose-status-reason" /> <code value="explot" /> <display value="Expired lot" /> </coding> </doseStatusReason> </vaccinationProtocol>