Antenatal Care IG for PWS KIA - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Antenatal Care Tetanus Administration (Immunization)

Describes the event of antenatal care patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Usage:

• Refer to this Resource Profile: Logical Model for ANC10T Scenario in Puskesmas Sampang
• Examples for this Resource Profile: Immunization/ImmunizationAdministered

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization(4.0.1)	Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier		1..1	Identifier	Business identifier ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children Fixed Value: completed
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(Patient | Patient(4.0.1))	Who was immunized ele-1: All FHIR elements must have a @value or children
Slices for occurrence[x]	SΣ	1..1		Vaccine administration date Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Vaccine administration date ele-1: All FHIR elements must have a @value or children
primarySource	SΣ	1..1	boolean	Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children Required Pattern: true
location		1..1	Reference(Location)	Where immunization occurred ele-1: All FHIR elements must have a @value or children
lotNumber		1..1	string	Vaccine lot number ele-1: All FHIR elements must have a @value or children
expirationDate		0..1	date	Vaccine expiration date ele-1: All FHIR elements must have a @value or children
site		1..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. ele-1: All FHIR elements must have a @value or children
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. ele-1: All FHIR elements must have a @value or children
performer	SΣ	0..1	BackboneElement	Who performed event ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	SΣ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
note	SΣ	0..1	Annotation	Additional immunization notes ele-1: All FHIR elements must have a @value or children
reasonCode		0..1	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. ele-1: All FHIR elements must have a @value or children
reasonReference		0..1	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred ele-1: All FHIR elements must have a @value or children
isSubpotent	?!Σ	0..1	boolean	Dose potency ele-1: All FHIR elements must have a @value or children
subpotentReason		0..1	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. ele-1: All FHIR elements must have a @value or children
education	C	0..1	BackboneElement	Educational material presented to patient ele-1: All FHIR elements must have a @value or children imm-1: One of documentType or reference SHALL be present
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
programEligibility		0..1	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. ele-1: All FHIR elements must have a @value or children
reaction		0..1	BackboneElement	Details of a reaction that follows immunization ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
date		0..1	dateTime	When reaction started ele-1: All FHIR elements must have a @value or children
detail		0..1	Reference(Observation)	Additional information on reaction ele-1: All FHIR elements must have a @value or children
reported		0..1	boolean	Indicates self-reported reaction ele-1: All FHIR elements must have a @value or children
protocolApplied		0..1	BackboneElement	Protocol followed by the provider ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
targetDisease		0..1	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. ele-1: All FHIR elements must have a @value or children
doseNumber[x]		1..1	positiveInt	Dose number within series ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization(4.0.1)	Immunization event information
status		1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://sys-ids.kemkes.go.id/kfa
code		0..1	code	Symbol in syntax defined by the system Required Pattern: VG139
display		0..1	string	Representation defined by the system Required Pattern: Td
occurrence[x]		1..1	dateTime, string	Vaccine administration date
primarySource		1..1	boolean	Indicates context the data was recorded in Required Pattern: true
location		1..1	Reference(Location)	Where immunization occurred
lotNumber		1..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		1..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.
performer
function		0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
reasonCode		0..1	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.kemkes.go.id/CodeSystem/immunization-reason
code		0..1	code	Symbol in syntax defined by the system Fixed Value: IM-WUS
display		0..1	string	Representation defined by the system Required Pattern: Imunisasi Program Rutin Lanjutan Wanita Usia Subur
reasonReference		0..1	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
reaction
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
doseNumber[x]		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization(4.0.1)	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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		1..1	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	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	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://sys-ids.kemkes.go.id/kfa
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: VG139
display	Σ	0..1	string	Representation defined by the system Required Pattern: Td
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Patient | Patient(4.0.1))	Who was immunized
encounter		0..1	Reference(Encounter | Encounter(4.0.1))	Encounter immunization was part of
Slices for occurrence[x]	SΣ	1..1		Vaccine administration date Slice: Unordered, Closed by type:$this
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Vaccine administration date
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	SΣ	1..1	boolean	Indicates context the data was recorded in Required Pattern: true
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		1..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		1..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		1..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		0..1	SimpleQuantity	Amount of vaccine administered
performer	SΣ	0..1	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	SΣ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
note	SΣ	0..1	Annotation	Additional immunization notes
reasonCode		0..1	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	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.kemkes.go.id/CodeSystem/immunization-reason
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: IM-WUS
display	Σ	0..1	string	Representation defined by the system Required Pattern: Imunisasi Program Rutin Lanjutan Wanita Usia Subur
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
reasonReference		0..1	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..1	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..1	BackboneElement	Educational material presented to patient imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
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..1	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..1	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		0..1	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..1	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x]		1..1	positiveInt	Dose number within series
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from Immunization

Summary

Mandatory: 4 elements
Fixed: 2 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization(4.0.1)	Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier		1..1	Identifier	Business identifier ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children Fixed Value: completed
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(Patient | Patient(4.0.1))	Who was immunized ele-1: All FHIR elements must have a @value or children
Slices for occurrence[x]	SΣ	1..1		Vaccine administration date Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Vaccine administration date ele-1: All FHIR elements must have a @value or children
primarySource	SΣ	1..1	boolean	Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children Required Pattern: true
location		1..1	Reference(Location)	Where immunization occurred ele-1: All FHIR elements must have a @value or children
lotNumber		1..1	string	Vaccine lot number ele-1: All FHIR elements must have a @value or children
expirationDate		0..1	date	Vaccine expiration date ele-1: All FHIR elements must have a @value or children
site		1..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. ele-1: All FHIR elements must have a @value or children
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. ele-1: All FHIR elements must have a @value or children
performer	SΣ	0..1	BackboneElement	Who performed event ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	SΣ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
note	SΣ	0..1	Annotation	Additional immunization notes ele-1: All FHIR elements must have a @value or children
reasonCode		0..1	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. ele-1: All FHIR elements must have a @value or children
reasonReference		0..1	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred ele-1: All FHIR elements must have a @value or children
isSubpotent	?!Σ	0..1	boolean	Dose potency ele-1: All FHIR elements must have a @value or children
subpotentReason		0..1	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. ele-1: All FHIR elements must have a @value or children
education	C	0..1	BackboneElement	Educational material presented to patient ele-1: All FHIR elements must have a @value or children imm-1: One of documentType or reference SHALL be present
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
programEligibility		0..1	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. ele-1: All FHIR elements must have a @value or children
reaction		0..1	BackboneElement	Details of a reaction that follows immunization ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
date		0..1	dateTime	When reaction started ele-1: All FHIR elements must have a @value or children
detail		0..1	Reference(Observation)	Additional information on reaction ele-1: All FHIR elements must have a @value or children
reported		0..1	boolean	Indicates self-reported reaction ele-1: All FHIR elements must have a @value or children
protocolApplied		0..1	BackboneElement	Protocol followed by the provider ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
targetDisease		0..1	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. ele-1: All FHIR elements must have a @value or children
doseNumber[x]		1..1	positiveInt	Dose number within series ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization(4.0.1)	Immunization event information
status		1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://sys-ids.kemkes.go.id/kfa
code		0..1	code	Symbol in syntax defined by the system Required Pattern: VG139
display		0..1	string	Representation defined by the system Required Pattern: Td
occurrence[x]		1..1	dateTime, string	Vaccine administration date
primarySource		1..1	boolean	Indicates context the data was recorded in Required Pattern: true
location		1..1	Reference(Location)	Where immunization occurred
lotNumber		1..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		1..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.
performer
function		0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
reasonCode		0..1	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.kemkes.go.id/CodeSystem/immunization-reason
code		0..1	code	Symbol in syntax defined by the system Fixed Value: IM-WUS
display		0..1	string	Representation defined by the system Required Pattern: Imunisasi Program Rutin Lanjutan Wanita Usia Subur
reasonReference		0..1	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
reaction
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
doseNumber[x]		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization(4.0.1)	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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		1..1	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	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	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://sys-ids.kemkes.go.id/kfa
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: VG139
display	Σ	0..1	string	Representation defined by the system Required Pattern: Td
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Patient | Patient(4.0.1))	Who was immunized
encounter		0..1	Reference(Encounter | Encounter(4.0.1))	Encounter immunization was part of
Slices for occurrence[x]	SΣ	1..1		Vaccine administration date Slice: Unordered, Closed by type:$this
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Vaccine administration date
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	SΣ	1..1	boolean	Indicates context the data was recorded in Required Pattern: true
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		1..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		1..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		1..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		0..1	SimpleQuantity	Amount of vaccine administered
performer	SΣ	0..1	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	SΣ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
note	SΣ	0..1	Annotation	Additional immunization notes
reasonCode		0..1	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	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.kemkes.go.id/CodeSystem/immunization-reason
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: IM-WUS
display	Σ	0..1	string	Representation defined by the system Required Pattern: Imunisasi Program Rutin Lanjutan Wanita Usia Subur
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
reasonReference		0..1	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..1	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..1	BackboneElement	Educational material presented to patient imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
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..1	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..1	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		0..1	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..1	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x]		1..1	positiveInt	Dose number within series
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from Immunization

Summary

Mandatory: 4 elements
Fixed: 2 elements

Other representations of profile: CSV, Excel, Schematron