PH eReferral Implementation Guide
0.1.0 - ci-build
PH eReferral Implementation Guide
0.1.0 - ci-build
PH eReferral Implementation Guide, published by SILab CoP IG Accelerator (eReferral). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jldalisay95/ph-ereferral-jld/ and changes regularly. See the Directory of published versions
| Official URL: urn://example.com/ph-ereferral/fhir/StructureDefinition/ereferral-immunization | Version: 0.1.0 | ||||
| Draft as of 2026-04-29 | Computable Name: ERefImmunization | ||||
Immunization profile for the Philippine eReferral system. Extends PHCoreImmunization to define must-support elements for referral clinical context. Immunization records are referenced via ServiceRequest.supportingInfo to provide supporting clinical information about a patient's vaccination history.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
  Immunization |
|||
  Slices for extension |
|||
   extension:batchNumber |
|
|
|
 extension:administeredProduct |
|
|
|
  status |
|
|
|
 statusReason |
|
|
|
| coding |
|
|
|
 text |
|
|
|
| vaccineCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
 patient |
|
|
|
| encounter |
|
|
|
| occurrence[x] |
|
|
|
| primarySource |
|
|
|
| reportOrigin |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| location |
|
|
|
| lotNumber |
|
|
|
| site |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| route |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| performer |
|
|
|
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
 actor |
|
|
|
 display |
|
|
|
| note |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subpotentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| programEligibility |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| fundingSource |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| protocolApplied |
|
|
|
| targetDisease |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for doseNumber[x] |
|||
| doseNumber[x]:doseNumberPositiveInt |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std. |
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
| Immunization |
0..* | PHCoreImmunization | Immunization event information | |
 vaccineCode |
1..1 | CodeableConcept | Vaccine product administered | |
| patient |
1..1 | Reference(ERefPatient) | Patient who was immunized | |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | PHCoreImmunization | 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:batchNumber |
SO | 0..1 | string | Batch Number URL: https://fhir.doh.gov.ph/phcore/StructureDefinition/batch-number
| ||||||||||||
| extension:administeredProduct |
SO | 0..1 | Reference(PH Core Medication) | Administered Product URL: https://fhir.doh.gov.ph/phcore/StructureDefinition/administered-product
| ||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
0..* | Identifier | Business identifier | |||||||||||||
| status |
?!SOΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
| ||||||||||||
| statusReason |
SO | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| vaccineCode |
SOΣ | 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 | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| patient |
SOΣ | 1..1 | Reference(ERefPatient) | Patient who was immunized
| ||||||||||||
| encounter |
SO | 0..1 | Reference(PH Core Encounter) | Encounter immunization was part of
| ||||||||||||
| occurrence[x] |
SOΣ | 1..1 | dateTime | Vaccine administration date
| ||||||||||||
| recorded |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||||||||
| primarySource |
SOΣ | 0..1 | boolean | Indicates context the data was recorded in
| ||||||||||||
| reportOrigin |
SO | 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.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| location |
SO | 0..1 | Reference(PH Core Location) | Where immunization occurred
| ||||||||||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||||||||||
| lotNumber |
SO | 0..1 | string | Vaccine lot number
| ||||||||||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||||||||||
| site |
SO | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| route |
SO | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| doseQuantity |
0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | |||||||||||||
| performer |
SOΣ | 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 |
SOΣ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| actor |
SOΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization) | Individual or organization who was performing
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
| display |
SOΣ | 0..1 | string | Text alternative for the resource
| ||||||||||||
| note |
SOΣ | 0..* | Annotation | Additional immunization notes
| ||||||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||||||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||||||||||
| subpotentReason |
SO | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| 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 |
SO | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| fundingSource |
SO | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| 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(Observation) | Additional information on reaction | |||||||||||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||||||||||
| protocolApplied |
SO | 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 |
SO | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Slices for doseNumber[x] |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||||||||||||||
| doseNumberPositiveInt |
positiveInt | |||||||||||||||
| doseNumberString |
string | |||||||||||||||
| doseNumber[x]:doseNumberPositiveInt |
SO | 0..1 | positiveInt | Dose number within series
| ||||||||||||
 seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||||||||||
| seriesDosesPositiveInt |
positiveInt | |||||||||||||||
| seriesDosesString |
string | |||||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Immunization |
|||
| Slices for extension |
|||
| extension:batchNumber |
|
|
|
| extension:administeredProduct |
|
|
|
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| vaccineCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| patient |
|
|
|
| encounter |
|
|
|
| occurrence[x] |
|
|
|
| primarySource |
|
|
|
| reportOrigin |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| location |
|
|
|
| lotNumber |
|
|
|
| site |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| route |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| performer |
|
|
|
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| actor |
|
|
|
| display |
|
|
|
| note |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subpotentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| programEligibility |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| fundingSource |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| protocolApplied |
|
|
|
| targetDisease |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for doseNumber[x] |
|||
| doseNumber[x]:doseNumberPositiveInt |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📍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 | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std. |
| 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.performer.actor.type | Base | extensible | ResourceType | 📍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()
|
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Immunization |
|||
| Slices for extension |
|||
| extension:batchNumber |
|
|
|
| extension:administeredProduct |
|
|
|
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| vaccineCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| patient |
|
|
|
| encounter |
|
|
|
| occurrence[x] |
|
|
|
| primarySource |
|
|
|
| reportOrigin |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| location |
|
|
|
| lotNumber |
|
|
|
| site |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| route |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| performer |
|
|
|
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| actor |
|
|
|
| display |
|
|
|
| note |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subpotentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| programEligibility |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| fundingSource |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| protocolApplied |
|
|
|
| targetDisease |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for doseNumber[x] |
|||
| doseNumber[x]:doseNumberPositiveInt |
|
|
|
| Documentation for this format | |||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | PHCoreImmunization | 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:batchNumber |
SO | 0..1 | string | Batch Number URL: https://fhir.doh.gov.ph/phcore/StructureDefinition/batch-number
| ||||||||||||
| extension:administeredProduct |
SO | 0..1 | Reference(PH Core Medication) | Administered Product URL: https://fhir.doh.gov.ph/phcore/StructureDefinition/administered-product
| ||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| status |
?!SOΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
| ||||||||||||
| statusReason |
SO | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| vaccineCode |
SOΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| patient |
SOΣ | 1..1 | Reference(ERefPatient) | Patient who was immunized
| ||||||||||||
| encounter |
SO | 0..1 | Reference(PH Core Encounter) | Encounter immunization was part of
| ||||||||||||
| occurrence[x] |
SOΣ | 1..1 | dateTime | Vaccine administration date
| ||||||||||||
| primarySource |
SOΣ | 0..1 | boolean | Indicates context the data was recorded in
| ||||||||||||
| reportOrigin |
SO | 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.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| location |
SO | 0..1 | Reference(PH Core Location) | Where immunization occurred
| ||||||||||||
| lotNumber |
SO | 0..1 | string | Vaccine lot number
| ||||||||||||
| site |
SO | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| route |
SO | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| performer |
SOΣ | 0..* | BackboneElement | Who performed event
| ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| function |
SOΣ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| actor |
SOΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization) | Individual or organization who was performing
| ||||||||||||
| display |
SOΣ | 0..1 | string | Text alternative for the resource
| ||||||||||||
| note |
SOΣ | 0..* | Annotation | Additional immunization notes
| ||||||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||||||||||
| subpotentReason |
SO | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| programEligibility |
SO | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| fundingSource |
SO | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| protocolApplied |
SO | 0..* | BackboneElement | Protocol followed by the provider
| ||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| targetDisease |
SO | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Slices for doseNumber[x] |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||||||||||||||
| doseNumberPositiveInt |
positiveInt | |||||||||||||||
| doseNumberString |
string | |||||||||||||||
| doseNumber[x]:doseNumberPositiveInt |
SO | 0..1 | positiveInt | Dose number within series
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Immunization |
|||
| Slices for extension |
|||
| extension:batchNumber |
|
|
|
| extension:administeredProduct |
|
|
|
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| vaccineCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| patient |
|
|
|
| encounter |
|
|
|
| occurrence[x] |
|
|
|
| primarySource |
|
|
|
| reportOrigin |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| location |
|
|
|
| lotNumber |
|
|
|
| site |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| route |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| performer |
|
|
|
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| actor |
|
|
|
| display |
|
|
|
| note |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subpotentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| programEligibility |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| fundingSource |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| protocolApplied |
|
|
|
| targetDisease |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for doseNumber[x] |
|||
| doseNumber[x]:doseNumberPositiveInt |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std. |
| 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()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | PHCoreImmunization | Immunization event information | |
| vaccineCode |
1..1 | CodeableConcept | Vaccine product administered | |
| patient |
1..1 | Reference(ERefPatient) | Patient who was immunized | |
| Documentation for this format | ||||
| Name |
|---|
| Documentation for this format |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | PHCoreImmunization | 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:batchNumber |
SO | 0..1 | string | Batch Number URL: https://fhir.doh.gov.ph/phcore/StructureDefinition/batch-number
| ||||||||||||
| extension:administeredProduct |
SO | 0..1 | Reference(PH Core Medication) | Administered Product URL: https://fhir.doh.gov.ph/phcore/StructureDefinition/administered-product
| ||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
0..* | Identifier | Business identifier | |||||||||||||
| status |
?!SOΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
| ||||||||||||
| statusReason |
SO | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| vaccineCode |
SOΣ | 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 | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| patient |
SOΣ | 1..1 | Reference(ERefPatient) | Patient who was immunized
| ||||||||||||
| encounter |
SO | 0..1 | Reference(PH Core Encounter) | Encounter immunization was part of
| ||||||||||||
| occurrence[x] |
SOΣ | 1..1 | dateTime | Vaccine administration date
| ||||||||||||
| recorded |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||||||||
| primarySource |
SOΣ | 0..1 | boolean | Indicates context the data was recorded in
| ||||||||||||
| reportOrigin |
SO | 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.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| location |
SO | 0..1 | Reference(PH Core Location) | Where immunization occurred
| ||||||||||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||||||||||
| lotNumber |
SO | 0..1 | string | Vaccine lot number
| ||||||||||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||||||||||
| site |
SO | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| route |
SO | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| doseQuantity |
0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | |||||||||||||
| performer |
SOΣ | 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 |
SOΣ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| actor |
SOΣ | 1..1 | Reference(PH Core Practitioner | PH Core PractitionerRole | PH Core Organization) | Individual or organization who was performing
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
| display |
SOΣ | 0..1 | string | Text alternative for the resource
| ||||||||||||
| note |
SOΣ | 0..* | Annotation | Additional immunization notes
| ||||||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||||||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||||||||||
| subpotentReason |
SO | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| 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 |
SO | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| fundingSource |
SO | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| 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(Observation) | Additional information on reaction | |||||||||||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||||||||||
| protocolApplied |
SO | 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 |
SO | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Slices for doseNumber[x] |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||||||||||||||
| doseNumberPositiveInt |
positiveInt | |||||||||||||||
| doseNumberString |
string | |||||||||||||||
| doseNumber[x]:doseNumberPositiveInt |
SO | 0..1 | positiveInt | Dose number within series
| ||||||||||||
| seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||||||||||
| seriesDosesPositiveInt |
positiveInt | |||||||||||||||
| seriesDosesString |
string | |||||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Immunization |
|||
| Slices for extension |
|||
| extension:batchNumber |
|
|
|
| extension:administeredProduct |
|
|
|
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| vaccineCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| patient |
|
|
|
| encounter |
|
|
|
| occurrence[x] |
|
|
|
| primarySource |
|
|
|
| reportOrigin |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| location |
|
|
|
| lotNumber |
|
|
|
| site |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| route |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| performer |
|
|
|
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| actor |
|
|
|
| display |
|
|
|
| note |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subpotentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| programEligibility |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| fundingSource |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| protocolApplied |
|
|
|
| targetDisease |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for doseNumber[x] |
|||
| doseNumber[x]:doseNumberPositiveInt |
|
|
|
| Documentation for this format | |||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📍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 | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std. |
| 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.performer.actor.type | Base | extensible | ResourceType | 📍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()
|
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| Immunization |
|||
| Slices for extension |
|||
| extension:batchNumber |
|
|
|
| extension:administeredProduct |
|
|
|
| status |
|
|
|
| statusReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| vaccineCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| patient |
|
|
|
| encounter |
|
|
|
| occurrence[x] |
|
|
|
| primarySource |
|
|
|
| reportOrigin |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| location |
|
|
|
| lotNumber |
|
|
|
| site |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| route |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| performer |
|
|
|
| function |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| actor |
|
|
|
| display |
|
|
|
| note |
|
|
|
| reasonCode |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| subpotentReason |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| programEligibility |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| fundingSource |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| protocolApplied |
|
|
|
| targetDisease |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Slices for doseNumber[x] |
|||
| doseNumber[x]:doseNumberPositiveInt |
|
|
|
| Documentation for this format | |||
Other representations of profile: CSV, Excel, Schematron
