Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-04-09 |
Definitions for the zib-VaccinationRecommendation resource profile.
Guidance on how to interpret the contents of this table can be found here
0. ImmunizationRecommendation | |
2. ImmunizationRecommendation.extension | |
Slicing | This element introduces a set of slices on ImmunizationRecommendation.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
4. ImmunizationRecommendation.extension:orderStatus | |
Slice Name | orderStatus |
Definition | The status of the order / recommendation. |
Short | OrderStatus |
Control | 0..1 |
Type | Extension(HCIM VaccinationRecommendation OrderStatus) (Extension Type: CodeableConcept) |
Alternate Names | OrderStatus |
6. ImmunizationRecommendation.extension:orderStatus.valueCodeableConcept:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
8. ImmunizationRecommendation.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
10. ImmunizationRecommendation.patient | |
Type | Reference(nl-core-patient) |
12. ImmunizationRecommendation.recommendation | |
14. ImmunizationRecommendation.recommendation.date | |
Definition | Date on which this vaccination will have to be repeated according to the author’s information. |
Short | DesiredDateForRevaccination |
Alternate Names | GewensteDatumHervaccinatie |
16. ImmunizationRecommendation.recommendation.vaccineCode | |
Definition | The product code of the vaccine administered. There are several possible code systems for documenting the product code. If the vaccination data is registered based on an anamnesis, coding with the ATC code is preferred. In all cases it concerns those products that fall under ATC group J07 (vaccines). |
Short | ProductCode |
Alternate Names | ProductCode |
18. ImmunizationRecommendation.recommendation.vaccineCode.coding | |
Control | 1..? |
Slicing | This element introduces a set of slices on ImmunizationRecommendation.recommendation.vaccineCode.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: |
20. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst | |
Slice Name | productCodeGPKCodelijst |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeGPKCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000 )ProductCodeGPKCodelijst |
22. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst | |
Slice Name | productCodeHPKCodelijst |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeHPKCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000 )ProductCodeHPKCodelijst |
24. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst | |
Slice Name | productCodeZICodelijst |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeZICodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000 )ProductCodeZICodelijst |
26. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst | |
Slice Name | productCodeATCCodelijst |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeATCCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000 )ProductCodeATCCodelijst |
28. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst | |
Slice Name | productCodePRKCodelijst |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ProductCodePRKCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000 )ProductCodePRKCodelijst |
30. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst | |
Slice Name | productCodeGTINCodelijst |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeGTINCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000 )ProductCodeGTINCodelijst |
32. ImmunizationRecommendation.recommendation.dateCriterion | |
Short | StartDate / EndDate |
Comments | This element can be used to capture the StartDate and EndDate concepts of the ZIB OverdrachtGeplandeZorgActiviteit. |
Alternate Names | StartDate, EndDate |
34. ImmunizationRecommendation.recommendation.protocol | |
36. ImmunizationRecommendation.recommendation.protocol.authority | |
Type | Reference(nl-core-organization) |
38. ImmunizationRecommendation.recommendation.supportingImmunization | |
Type | Reference(HCIM Vaccination) |
40. ImmunizationRecommendation.recommendation.supportingPatientInformation | |
Type | Reference(HCIM AllergyIntolerance) |
Guidance on how to interpret the contents of this table can be found here
0. ImmunizationRecommendation | |
Definition | A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification. |
Short | Guidance or advice relating to an immunization |
Control | 0..* |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty() )dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
2. ImmunizationRecommendation.implicitRules | |
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. |
Short | A set of rules under which this content was created |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
4. ImmunizationRecommendation.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on ImmunizationRecommendation.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
6. ImmunizationRecommendation.extension:orderStatus | |
Slice Name | orderStatus |
Definition | The status of the order / recommendation. |
Short | OrderStatus |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM VaccinationRecommendation OrderStatus) (Extension Type: CodeableConcept) |
Alternate Names | OrderStatus |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
8. ImmunizationRecommendation.extension:orderStatus.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus |
10. ImmunizationRecommendation.extension:orderStatus.value[x] | |
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). |
Short | Value of extension |
Control | 0..1 |
Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on ImmunizationRecommendation.extension.value[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: |
12. ImmunizationRecommendation.extension:orderStatus.value[x]:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
Definition | The status of the order / recommendation Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | OrderStatusValue of extension |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see OrderStatusCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000 ) |
Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
[x] Note | See Choice of Data Types for further information about how to use [x] |
14. ImmunizationRecommendation.modifierExtension | |
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. |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Alternate Names | extensions, user content |
16. ImmunizationRecommendation.identifier | |
Definition | A unique identifier assigned to this particular recommendation record. |
Short | Business identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
18. ImmunizationRecommendation.patient | |
Definition | The patient the recommendations are for. |
Short | Who this profile is for |
Control | 1..1 |
Type | Reference(nl-core-patient, Patient) |
Summary | true |
20. ImmunizationRecommendation.recommendation | |
Definition | Vaccine administration recommendations. |
Short | Vaccine administration recommendations |
Control | 1..* |
Type | BackboneElement |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )imr-1: One of vaccineCode or targetDisease SHALL be present ( vaccineCode.exists() or targetDisease.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) imr-1: One of vaccineCode or targetDisease SHALL be present (vaccineCode.exists() or targetDisease.exists()) |
22. ImmunizationRecommendation.recommendation.modifierExtension | |
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. |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Summary | true |
Alternate Names | extensions, user content, modifiers |
24. ImmunizationRecommendation.recommendation.date | |
Definition | Date on which this vaccination will have to be repeated according to the author’s information. The date the immunization recommendation was created. |
Short | DesiredDateForRevaccinationDate recommendation created |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | GewensteDatumHervaccinatie |
26. ImmunizationRecommendation.recommendation.vaccineCode | |
Definition | The product code of the vaccine administered. There are several possible code systems for documenting the product code. If the vaccination data is registered based on an anamnesis, coding with the ATC code is preferred. In all cases it concerns those products that fall under ATC group J07 (vaccines). Vaccine that pertains to the recommendation. |
Short | ProductCodeVaccine recommendation applies to |
Control | 0..1 |
Binding | For example codes, see Vaccine Administered Value Sethttp://hl7.org/fhir/ValueSet/vaccine-code (example to http://hl7.org/fhir/ValueSet/vaccine-code )The type of vaccine administered |
Type | CodeableConcept |
Summary | true |
Alternate Names | ProductCode |
28. ImmunizationRecommendation.recommendation.vaccineCode.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
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. |
Control | 10..* |
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. |
Slicing | This element introduces a set of slices on ImmunizationRecommendation.recommendation.vaccineCode.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: |
30. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst | |
Slice Name | productCodeGPKCodelijst |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
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. |
Control | 0..1* |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see ProductCodeGPKCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000 )ProductCodeGPKCodelijst |
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. |
32. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst | |
Slice Name | productCodeHPKCodelijst |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
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. |
Control | 0..1* |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see ProductCodeHPKCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000 )ProductCodeHPKCodelijst |
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. |
34. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst | |
Slice Name | productCodeZICodelijst |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
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. |
Control | 0..1* |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see ProductCodeZICodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000 )ProductCodeZICodelijst |
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. |
36. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst | |
Slice Name | productCodeATCCodelijst |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
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. |
Control | 0..1* |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see ProductCodeATCCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000 )ProductCodeATCCodelijst |
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. |
38. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst | |
Slice Name | productCodePRKCodelijst |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
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. |
Control | 0..1* |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see ProductCodePRKCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000 )ProductCodePRKCodelijst |
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. |
40. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst | |
Slice Name | productCodeGTINCodelijst |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
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. |
Control | 0..1* |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see ProductCodeGTINCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000 )ProductCodeGTINCodelijst |
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. |
42. ImmunizationRecommendation.recommendation.forecastStatus | |
Definition | Vaccine administration status. |
Short | Vaccine administration status |
Control | 1..1 |
Binding | For example codes, see Immunization Recommendation Status Codeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-status (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-status )The patient's status with respect to a vaccination protocol |
Type | CodeableConcept |
Summary | true |
44. ImmunizationRecommendation.recommendation.dateCriterion | |
Definition | Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc. |
Short | StartDate / EndDateDates governing proposed immunization |
Comments | This element can be used to capture the StartDate and EndDate concepts of the ZIB OverdrachtGeplandeZorgActiviteit. |
Control | 0..* |
Type | BackboneElement |
Alternate Names | StartDate, EndDate |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
46. ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension | |
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. |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Summary | true |
Alternate Names | extensions, user content, modifiers |
48. ImmunizationRecommendation.recommendation.dateCriterion.code | |
Definition | Date classification of recommendation. For example, earliest date to give, latest date to give, etc. |
Short | Type of date |
Control | 1..1 |
Binding | For example codes, see Immunization Recommendation Date Criterion Codeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion )Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.) |
Type | CodeableConcept |
50. ImmunizationRecommendation.recommendation.dateCriterion.value | |
Definition | The date whose meaning is specified by dateCriterion.code. |
Short | Recommended date |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. ImmunizationRecommendation.recommendation.supportingImmunization | |
Definition | Immunization event history that supports the status and recommendation. |
Short | Past immunizations supporting recommendation |
Control | 0..* |
Type | Reference(HCIM Vaccination, Immunization) |
54. ImmunizationRecommendation.recommendation.supportingPatientInformation | |
Definition | Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. |
Short | Patient observations supporting recommendation |
Control | 0..* |
Type | Reference(HCIM AllergyIntolerance, Observation, AllergyIntolerance) |
Guidance on how to interpret the contents of this table can be found here
0. ImmunizationRecommendation | |||||
Definition | A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification. | ||||
Short | Guidance or advice relating to an immunization | ||||
Control | 0..* | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty() ) | ||||
2. ImmunizationRecommendation.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
4. ImmunizationRecommendation.meta | |||||
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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
6. ImmunizationRecommendation.implicitRules | |||||
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. | ||||
Short | A set of rules under which this content was created | ||||
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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
8. ImmunizationRecommendation.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
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). | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
10. ImmunizationRecommendation.text | |||||
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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
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. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
12. ImmunizationRecommendation.contained | |||||
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. | ||||
Short | Contained, inline 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. ImmunizationRecommendation.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on ImmunizationRecommendation.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
16. ImmunizationRecommendation.extension:orderStatus | |||||
Slice Name | orderStatus | ||||
Definition | The status of the order / recommendation. | ||||
Short | OrderStatus | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM VaccinationRecommendation OrderStatus) (Extension Type: CodeableConcept) | ||||
Alternate Names | OrderStatus | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. ImmunizationRecommendation.extension:orderStatus.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
20. ImmunizationRecommendation.extension:orderStatus.extension | |||||
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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on ImmunizationRecommendation.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
22. ImmunizationRecommendation.extension:orderStatus.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
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. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus | ||||
24. ImmunizationRecommendation.extension:orderStatus.value[x] | |||||
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). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Slicing | This element introduces a set of slices on ImmunizationRecommendation.extension.value[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: | ||||
26. ImmunizationRecommendation.extension:orderStatus.value[x]:valueCodeableConcept | |||||
Slice Name | valueCodeableConcept | ||||
Definition | The status of the order / recommendation | ||||
Short | OrderStatus | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from OrderStatusCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000 ) | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
28. ImmunizationRecommendation.modifierExtension | |||||
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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Alternate Names | extensions, user content | ||||
30. ImmunizationRecommendation.identifier | |||||
Definition | A unique identifier assigned to this particular recommendation record. | ||||
Short | Business identifier | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
32. ImmunizationRecommendation.patient | |||||
Definition | The patient the recommendations are for. | ||||
Short | Who this profile is for | ||||
Control | 1..1 | ||||
Type | Reference(nl-core-patient) | ||||
Summary | true | ||||
34. ImmunizationRecommendation.recommendation | |||||
Definition | Vaccine administration recommendations. | ||||
Short | Vaccine administration recommendations | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )imr-1: One of vaccineCode or targetDisease SHALL be present ( vaccineCode.exists() or targetDisease.exists() ) | ||||
36. ImmunizationRecommendation.recommendation.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
38. ImmunizationRecommendation.recommendation.extension | |||||
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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
40. ImmunizationRecommendation.recommendation.modifierExtension | |||||
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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
42. ImmunizationRecommendation.recommendation.date | |||||
Definition | Date on which this vaccination will have to be repeated according to the author’s information. | ||||
Short | DesiredDateForRevaccination | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | GewensteDatumHervaccinatie | ||||
44. ImmunizationRecommendation.recommendation.vaccineCode | |||||
Definition | The product code of the vaccine administered. There are several possible code systems for documenting the product code. If the vaccination data is registered based on an anamnesis, coding with the ATC code is preferred. In all cases it concerns those products that fall under ATC group J07 (vaccines). | ||||
Short | ProductCode | ||||
Control | 0..1 | ||||
Binding | For example codes, see Vaccine Administered Value Set (example to http://hl7.org/fhir/ValueSet/vaccine-code )The type of vaccine administered | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Alternate Names | ProductCode | ||||
46. ImmunizationRecommendation.recommendation.vaccineCode.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
48. ImmunizationRecommendation.recommendation.vaccineCode.extension | |||||
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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on ImmunizationRecommendation.recommendation.vaccineCode.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
50. ImmunizationRecommendation.recommendation.vaccineCode.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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. | ||||
Control | 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. | ||||
Slicing | This element introduces a set of slices on ImmunizationRecommendation.recommendation.vaccineCode.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
52. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst | |||||
Slice Name | productCodeGPKCodelijst | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeGPKCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000 )ProductCodeGPKCodelijst | ||||
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. | ||||
54. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst | |||||
Slice Name | productCodeHPKCodelijst | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeHPKCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000 )ProductCodeHPKCodelijst | ||||
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. | ||||
56. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst | |||||
Slice Name | productCodeZICodelijst | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeZICodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000 )ProductCodeZICodelijst | ||||
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. | ||||
58. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst | |||||
Slice Name | productCodeATCCodelijst | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeATCCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000 )ProductCodeATCCodelijst | ||||
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. | ||||
60. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst | |||||
Slice Name | productCodePRKCodelijst | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProductCodePRKCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000 )ProductCodePRKCodelijst | ||||
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. | ||||
62. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst | |||||
Slice Name | productCodeGTINCodelijst | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProductCodeGTINCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000 )ProductCodeGTINCodelijst | ||||
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. | ||||
64. ImmunizationRecommendation.recommendation.vaccineCode.text | |||||
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. | ||||
Short | Plain text representation of the concept | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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. | ||||
66. ImmunizationRecommendation.recommendation.targetDisease | |||||
Definition | The targeted disease for the recommendation. | ||||
Short | Disease to be immunized against | ||||
Control | 0..1 | ||||
Binding | For example codes, see Immunization Recommendation Target Disease Codes (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease )The disease that the recommended vaccination targets | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
68. ImmunizationRecommendation.recommendation.doseNumber | |||||
Definition | The next recommended dose number (e.g. dose 2 is the next recommended dose). | ||||
Short | Recommended dose number | ||||
Comments | May need other dose concepts such as administered vs. valid. | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
70. ImmunizationRecommendation.recommendation.forecastStatus | |||||
Definition | Vaccine administration status. | ||||
Short | Vaccine administration status | ||||
Control | 1..1 | ||||
Binding | For example codes, see Immunization Recommendation Status Codes (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-status )The patient's status with respect to a vaccination protocol | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
72. ImmunizationRecommendation.recommendation.dateCriterion | |||||
Definition | Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc. | ||||
Short | StartDate / EndDate | ||||
Comments | This element can be used to capture the StartDate and EndDate concepts of the ZIB OverdrachtGeplandeZorgActiviteit. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Alternate Names | StartDate, EndDate | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
74. ImmunizationRecommendation.recommendation.dateCriterion.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
76. ImmunizationRecommendation.recommendation.dateCriterion.extension | |||||
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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
78. ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension | |||||
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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
80. ImmunizationRecommendation.recommendation.dateCriterion.code | |||||
Definition | Date classification of recommendation. For example, earliest date to give, latest date to give, etc. | ||||
Short | Type of date | ||||
Control | 1..1 | ||||
Binding | For example codes, see Immunization Recommendation Date Criterion Codes (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion )Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.) | ||||
Type | CodeableConcept | ||||
82. ImmunizationRecommendation.recommendation.dateCriterion.value | |||||
Definition | The date whose meaning is specified by dateCriterion.code. | ||||
Short | Recommended date | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
84. ImmunizationRecommendation.recommendation.protocol | |||||
Definition | Contains information about the protocol under which the vaccine was administered. | ||||
Short | Protocol used by recommendation | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
86. ImmunizationRecommendation.recommendation.protocol.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
88. ImmunizationRecommendation.recommendation.protocol.extension | |||||
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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
90. ImmunizationRecommendation.recommendation.protocol.modifierExtension | |||||
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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
92. ImmunizationRecommendation.recommendation.protocol.doseSequence | |||||
Definition | Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol. | ||||
Short | Dose number within sequence | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
94. ImmunizationRecommendation.recommendation.protocol.description | |||||
Definition | Contains the description about the protocol under which the vaccine was administered. | ||||
Short | Protocol details | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
96. ImmunizationRecommendation.recommendation.protocol.authority | |||||
Definition | Indicates the authority who published the protocol. For example, ACIP. | ||||
Short | Who is responsible for protocol | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-organization) | ||||
98. ImmunizationRecommendation.recommendation.protocol.series | |||||
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. | ||||
Short | Name of vaccination series | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
100. ImmunizationRecommendation.recommendation.supportingImmunization | |||||
Definition | Immunization event history that supports the status and recommendation. | ||||
Short | Past immunizations supporting recommendation | ||||
Control | 0..* | ||||
Type | Reference(HCIM Vaccination) | ||||
102. ImmunizationRecommendation.recommendation.supportingPatientInformation | |||||
Definition | Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. | ||||
Short | Patient observations supporting recommendation | ||||
Control | 0..* | ||||
Type | Reference(HCIM AllergyIntolerance) |