WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build
WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build
WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-anc/ and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/anc/StructureDefinition/tetanus-toxoid-tt-5-immunization | Version: 0.3.0 | |||
| Draft as of 2026-10-16 | Computable Name: TetanustoxoidTT5Immunization | |||
Usage:Workflow Task: Immunizations |
||||
Tetanus toxoid (TT) 5 Immunization
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Immunization |
0..* | ANCImmunization | Immunization event information | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:instantiatesCaseFeature |
0..1 | canonical(StructureDefinition) | Definition of this case feature URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | |
| extension:caseFeatureType |
0..1 | code | asserted | inferred URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred | |
| extension:caseFeaturePertinence |
0..1 | code | weakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature | |
| extension:basedOn |
0..1 | Reference(Resource) | Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn | |
 extension:pertinent |
0..* | Reference() | Pertinent information URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
1..* | Identifier | Business identifier | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
 value |
1..1 | string | The value that is unique Example General: 123456 | |
| status |
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. | |
| vaccineCode |
1..1 | CodeableConcept | Tetanus toxoid (TT) 5 immunization provided Binding: Tetanus toxoid (TT) 5 immunization provided (required) | |
 patient |
1..1 | Reference(ANC Base Patient) | Who was immunized | |
| encounter |
0..1 | Reference(ANC Base Encounter) | Encounter immunization was part of | |
| occurrence[x] |
1..1 | dateTime | Date tetanus toxoid 5 immunization was received | |
| recorded |
1..1 | dateTime | When the immunization was first captured in the subject's record | |
| primarySource |
1..1 | boolean | Indicates context the data was recorded in | |
| location |
0..1 | Reference(ANC Location) | Where immunization occurred | |
| site |
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: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |
| doseQuantity |
C | 0..1 | SimpleQuantity | Amount of vaccine administered Constraints: sqty-1 |
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |
| isSubpotent |
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. | |
 reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| detail |
0..1 | Reference(ANC Observation) | Additional information on reaction | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | required | Tetanus toxoid (TT) 5 immunization provided | 📦0.3.0 | This IG |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📦4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📦4.0.1 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | 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-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Immunization.doseQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from ANCImmunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | ANCImmunization | Immunization event information | |
 vaccineCode |
1..1 | CodeableConcept | Tetanus toxoid (TT) 5 immunization provided Binding: Tetanus toxoid (TT) 5 immunization provided (required) | |
| occurrence[x] |
1..1 | dateTime | Date tetanus toxoid 5 immunization was received | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.vaccineCode | Base | required | Tetanus toxoid (TT) 5 immunization provided | 📦0.3.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | ANCImmunization | Immunization event information | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:instantiatesCaseFeature |
0..1 | canonical(StructureDefinition) | Definition of this case feature URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | |||||
| extension:caseFeatureType |
0..1 | code | asserted | inferred URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred | |||||
| extension:caseFeaturePertinence |
0..1 | code | weakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature | |||||
| extension:basedOn |
0..1 | Reference(Resource) | Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn | |||||
| extension:pertinent |
0..* | Reference() | Pertinent information URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | Business identifier | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..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. | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
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) | |||||
| status |
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. | |||||
| vaccineCode |
1..1 | CodeableConcept | Tetanus toxoid (TT) 5 immunization provided Binding: Tetanus toxoid (TT) 5 immunization provided (required) | |||||
| patient |
1..1 | Reference(ANC Base Patient) | Who was immunized | |||||
| encounter |
0..1 | Reference(ANC Base Encounter) | Encounter immunization was part of | |||||
| occurrence[x] |
1..1 | dateTime | Date tetanus toxoid 5 immunization was received | |||||
| recorded |
1..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource |
1..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. | |||||
| location |
0..1 | Reference(ANC Location) | Where immunization occurred | |||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
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. | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
| doseQuantity |
C | 0..1 | SimpleQuantity | Amount of vaccine administered Constraints: sqty-1 | ||||
| performer |
0..* | BackboneElement | Who performed event | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
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. | |||||
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |||||
| note |
0..* | Annotation | Additional immunization notes | |||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent |
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. | |||||
| education |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| documentType |
0..1 | string | Educational material document identifier | |||||
| reference |
0..1 | uri | Educational material reference pointer | |||||
| publicationDate |
0..1 | dateTime | Educational material publication date | |||||
| presentationDate |
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. | |||||
| fundingSource |
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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(ANC Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
 doseNumber[x] |
1..1 | Dose number within series | ||||||
| doseNumberPositiveInt |
positiveInt | |||||||
| doseNumberString |
string | |||||||
| seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Immunization.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Immunization.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | required | Tetanus toxoid (TT) 5 immunization provided | 📦0.3.0 | This IG |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📦4.0.1 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📦4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📦4.0.1 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
| Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📦4.0.1 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📦4.0.1 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | 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-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present |
documentType.exists() or reference.exists()
|
| sqty-1 | error | Immunization.doseQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from ANCImmunization
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | ANCImmunization | Immunization event information | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:instantiatesCaseFeature |
0..1 | canonical(StructureDefinition) | Definition of this case feature URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | |
| extension:caseFeatureType |
0..1 | code | asserted | inferred URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred | |
| extension:caseFeaturePertinence |
0..1 | code | weakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature | |
| extension:basedOn |
0..1 | Reference(Resource) | Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn | |
| extension:pertinent |
0..* | Reference() | Pertinent information URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
1..* | Identifier | Business identifier | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| status |
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. | |
| vaccineCode |
1..1 | CodeableConcept | Tetanus toxoid (TT) 5 immunization provided Binding: Tetanus toxoid (TT) 5 immunization provided (required) | |
| patient |
1..1 | Reference(ANC Base Patient) | Who was immunized | |
| encounter |
0..1 | Reference(ANC Base Encounter) | Encounter immunization was part of | |
| occurrence[x] |
1..1 | dateTime | Date tetanus toxoid 5 immunization was received | |
| recorded |
1..1 | dateTime | When the immunization was first captured in the subject's record | |
| primarySource |
1..1 | boolean | Indicates context the data was recorded in | |
| location |
0..1 | Reference(ANC Location) | Where immunization occurred | |
| site |
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: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |
| doseQuantity |
C | 0..1 | SimpleQuantity | Amount of vaccine administered Constraints: sqty-1 |
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |
| isSubpotent |
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. | |
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| detail |
0..1 | Reference(ANC Observation) | Additional information on reaction | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | required | Tetanus toxoid (TT) 5 immunization provided | 📦0.3.0 | This IG |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📦4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📦4.0.1 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | 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-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sqty-1 | error | Immunization.doseQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
Differential View
This structure is derived from ANCImmunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | ANCImmunization | Immunization event information | |
| vaccineCode |
1..1 | CodeableConcept | Tetanus toxoid (TT) 5 immunization provided Binding: Tetanus toxoid (TT) 5 immunization provided (required) | |
| occurrence[x] |
1..1 | dateTime | Date tetanus toxoid 5 immunization was received | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.vaccineCode | Base | required | Tetanus toxoid (TT) 5 immunization provided | 📦0.3.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | ANCImmunization | Immunization event information | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
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): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:instantiatesCaseFeature |
0..1 | canonical(StructureDefinition) | Definition of this case feature URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature | |||||
| extension:caseFeatureType |
0..1 | code | asserted | inferred URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type (required): Whether the case feature is asserted or inferred | |||||
| extension:caseFeaturePertinence |
0..1 | code | weakly-positive | weakly-negative | strongly-positive | strongly-negative | pathognomonic URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence (required): Describes the pertinence of a case feature | |||||
| extension:basedOn |
0..1 | Reference(Resource) | Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn | |||||
| extension:pertinent |
0..* | Reference() | Pertinent information URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | Business identifier | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..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. | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
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) | |||||
| status |
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. | |||||
| vaccineCode |
1..1 | CodeableConcept | Tetanus toxoid (TT) 5 immunization provided Binding: Tetanus toxoid (TT) 5 immunization provided (required) | |||||
| patient |
1..1 | Reference(ANC Base Patient) | Who was immunized | |||||
| encounter |
0..1 | Reference(ANC Base Encounter) | Encounter immunization was part of | |||||
| occurrence[x] |
1..1 | dateTime | Date tetanus toxoid 5 immunization was received | |||||
| recorded |
1..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource |
1..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. | |||||
| location |
0..1 | Reference(ANC Location) | Where immunization occurred | |||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
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. | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
| doseQuantity |
C | 0..1 | SimpleQuantity | Amount of vaccine administered Constraints: sqty-1 | ||||
| performer |
0..* | BackboneElement | Who performed event | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
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. | |||||
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |||||
| note |
0..* | Annotation | Additional immunization notes | |||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent |
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. | |||||
| education |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| documentType |
0..1 | string | Educational material document identifier | |||||
| reference |
0..1 | uri | Educational material reference pointer | |||||
| publicationDate |
0..1 | dateTime | Educational material publication date | |||||
| presentationDate |
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. | |||||
| fundingSource |
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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(ANC Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
| doseNumber[x] |
1..1 | Dose number within series | ||||||
| doseNumberPositiveInt |
positiveInt | |||||||
| doseNumberString |
string | |||||||
| seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Immunization.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Immunization.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | required | Tetanus toxoid (TT) 5 immunization provided | 📦0.3.0 | This IG |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📦4.0.1 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📦4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📦4.0.1 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📦4.0.1 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📦4.0.1 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
| Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📦4.0.1 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📦4.0.1 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | 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-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present |
documentType.exists() or reference.exists()
|
| sqty-1 | error | Immunization.doseQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from ANCImmunization
Other representations of profile: CSV, Excel, Schematron