Left: | CH VACD Recommendation Immunization Profile (http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-immunization) |
Right: | CH VACD Recommendation Immunization Profile (http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-immunization) |
Error | StructureDefinition.version | Values for version differ: '1.0.0' vs '2.0.0' |
Information | StructureDefinition.date | Values for date differ: '2021-06-18T09:34:15+02:00' vs '2022-02-11T14:45:16+01:00' |
Information | StructureDefinition.publisher | Values for publisher differ: 'eHealth Suisse' vs 'HL7 Switzerland' |
Information | StructureDefinition.jurisdiction | Removed the item 'urn:iso:std:iso:3166#CH' |
Error | StructureDefinition.baseDefinition | Values for baseDefinition differ: 'http://hl7.org/fhir/StructureDefinition/Immunization' vs 'http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-immunization' |
Warning | Immunization | Elements differ in short: 'CH VACD Immunization' vs 'CH VACD Recommendation Immunization' |
Information | Immunization.vaccineCode | Example/preferred bindings differ at Immunization.vaccineCode using binding from CHVACDRecommendationImmunization |
Warning | Immunization.vaccineCode | Elements differ in binding.description: 'The type of vaccine for particular disease or diseases against which the patient has been immunised.' vs 'The code for vaccine product administered.' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Immunization | http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-immunization |
|
copyright | CC-BY-SA-4.0 |
| |
date | 2021-06-18T09:34:15+02:00 | 2022-02-11T14:45:16+01:00 |
|
description | Definition of the immunization part for immunization recommendation request and response documents. | ||
experimental | false | ||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#CH |
| |
kind | resource | ||
name | CHVACDRecommendationImmunization | ||
publisher | eHealth Suisse | HL7 Switzerland |
|
purpose | |||
status | active | ||
title | CH VACD Recommendation Immunization Profile | ||
type | Immunization | ||
url | http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-immunization | ||
version | 1.0.0 | 2.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments |
---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | Immunization | CH VACD Immunization | 0..* | CHVACDImmunization | CH VACD Recommendation Immunization |
| ||
id | Σ | 0..1 | string | Logical id of this artifact | Σ | 0..1 | string | Logical id of this artifact | |
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||
contained | 0..1 | Resource | Immunization inline resource | 0..1 | Resource | Immunization inline resource | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |
identifier | 1..* | Identifier | Immunization item ID | 1..* | Identifier | Immunization item ID | |||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | Σ | 0..1 | string | The value that is unique Example General: 123456 | |
period | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 0..1 | Period | Time period when id is/was valid for use | |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | |
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||
Slices for vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Slice: Unordered, Open by pattern:$this Binding: Swissmedic code for vaccine code (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised. | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
|
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
coding | Σ | 0..* | Coding | Code defined by a terminology system | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | |
text | Σ | 0..1 | string | Plain text representation of the concept | Σ | 0..1 | string | Plain text representation of the concept | |
patient | Σ | 1..1 | Reference(CH VACD Recommendation Patient Profile) | Patient | Σ | 1..1 | Reference(CH VACD Recommendation Patient Profile) | Patient | |
encounter | 0..0 | 0..0 | |||||||
occurrence[x] | Σ | 1..1 | dateTime, string | Vaccine administration date | Σ | 1..1 | dateTime, string | Vaccine administration date | |
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | Σ | 0..1 | boolean | Indicates context the data was recorded in | |
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||
location | 0..1 | Reference(Location) | Where immunization occurred | 0..1 | Reference(Location) | Where immunization occurred | |||
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||
lotNumber | 0..1 | string | Vaccine lot number | 0..1 | string | Vaccine lot number | |||
expirationDate | 0..1 | date | Vaccine expiration date | 0..1 | date | Vaccine expiration date | |||
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||
route | 0..1 | CodeableConcept | How vaccine entered body. Binding: Route of Administration for Immunization (extensible) | 0..1 | CodeableConcept | How vaccine entered body. Binding: Route of Administration for Immunization (extensible) | |||
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | 0..1 | SimpleQuantity | Amount of vaccine administered | |||
performer | Σ | 0..* | BackboneElement | Who performed event | Σ | 0..* | BackboneElement | Who performed event | |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | |
actor | Σ | 1..1 | Reference(CH VACD Recommendation PractitionerRole Profile) | The performer who applied the vaccine | Σ | 1..1 | Reference(CH VACD Recommendation PractitionerRole Profile) | The performer who applied the vaccine | |
note | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes | |
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ?!Σ | 0..1 | boolean | Dose potency | |
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||
education | I | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | I | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
documentType | 0..1 | string | Educational material document identifier | 0..1 | string | Educational material document identifier | |||
reference | 0..1 | uri | Educational material reference pointer | 0..1 | uri | Educational material reference pointer | |||
publicationDate | 0..1 | dateTime | Educational material publication date | 0..1 | dateTime | Educational material publication date | |||
presentationDate | 0..1 | dateTime | Educational material presentation date | 0..1 | dateTime | Educational material presentation date | |||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | 0..* | BackboneElement | Details of a reaction that follows immunization | |||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
date | 0..1 | dateTime | When reaction started | 0..1 | dateTime | When reaction started | |||
detail | 0..1 | Reference(Observation) | Additional information on reaction | 0..1 | Reference(Observation) | Additional information on reaction | |||
reported | 0..1 | boolean | Indicates self-reported reaction | 0..1 | boolean | Indicates self-reported reaction | |||
protocolApplied | 1..* | BackboneElement | Protocol followed by the provider | 1..* | BackboneElement | Protocol followed by the provider | |||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
series | 0..1 | string | Name of vaccine series | 0..1 | string | Name of vaccine series | |||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||
targetDisease | 1..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease. | 1..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease. | |||
doseNumber[x] | 1..1 | positiveInt, string | Dose number within series | 1..1 | positiveInt, string | Dose number within series | |||
seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity | 0..1 | positiveInt, string | Recommended number of doses for immunity | |||
Documentation for this format |