Bản hướng dẫn thực thi (IG) dành cho các hệ thống thông tin Y tế tại Việt Nam
1.0.0 - CI Build
Bản hướng dẫn thực thi (IG) dành cho các hệ thống thông tin Y tế tại Việt Nam, published by Cục Công nghệ thông tin - Bộ Y tế. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7vn/vn-core-ig/ and changes regularly. See the Directory of published versions
Thông tin tiêm chủng của người bệnh
Đường dẫn URL chính thức của Profile này:
http://fhir.ehealth.gov.vn/core/StructureDefinition/vn-core-immunization
Profile này được dựa trên Resource ImmunizationUvIps
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Profile này được dựa trên Resource ImmunizationUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | ImmunizationUvIps | |||
identifier | S | 0..* | Identifier | Business identifier |
statusReason | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text |
vaccineCode | 1..1 | VNCoreCodeableConcept | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. | |
Slices for vaccineCode | Content/Rules for all slices | |||
vaccineCode:vaccineCode | 0..1 | VNCoreCodeableConcept | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: ValueSet dành cho Vaccine Code (required) | |
patient | 1..1 | Reference(Patient Profile - VN Core R4) | Who was immunized | |
encounter | 1..1 | Reference(Encounter Profile - VN Core R4) | Encounter immunization was part of | |
recorded | S | 0..1 | dateTime | When the immunization was first captured in the subject's record |
reportOrigin | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
location | S | 0..1 | Reference(Location | Location Profile - VN Core R4) | Where immunization occurred |
manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer |
display | 1..1 | string | Text alternative for the resource | |
lotNumber | S | 0..1 | string | Vaccine lot number |
expirationDate | S | 0..1 | date | Vaccine expiration date |
site | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text |
route | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
doseQuantity | S | 0..1 | SimpleQuantity, SimpleQuantityIPS | Amount of vaccine administered |
performer | ||||
actor | 1..1 | Reference(Practitioner Profile - VN Core R4) | Individual or organization who was performing | |
reasonCode | S | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text |
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |
subpotentReason | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
programEligibility | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
fundingSource | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
reaction | S | 0..* | BackboneElement | Details of a reaction that follows immunization |
protocolApplied | S | 0..* | BackboneElement | Protocol followed by the provider |
targetDisease | 0..* | VNCoreCodeableConcept | Vaccine preventatable disease being targetted | |
Slices for targetDisease | Content/Rules for all slices | |||
targetDisease:targetDiseaseGPSCode | 0..1 | CodeableConcept | Code for a disease the vaccination is against from the SNOMED CT GPS code set. Binding: ValueSet dành cho Mã bệnh tật (required) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | S | 0..* | ImmunizationUvIps | 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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier | Business identifier | ||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
statusReason | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | ||||
Slices for vaccineCode | SΣ | 1..1 | VNCoreCodeableConcept | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Slice: Unordered, Open by pattern:$this Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised. | ||||
vaccineCode:vaccineGPSCode | SΣ | 0..1 | CodeableConcept | Code for vaccine from the SNOMED CT GPS code set Binding: Vaccines (GPS) - IPS (required) | ||||
vaccineCode:atcClass | SΣ | 0..1 | CodeableConcept | WHO ATC classification Binding: WHO ATC - IPS (required) | ||||
vaccineCode:absentOrUnknownImmunization | SΣ | 0..1 | CodeableConcept | Absent Unknown Immunization Binding: Absent or Unknown Immunization - IPS (required) | ||||
vaccineCode:vaccineCode | SΣ | 0..1 | VNCoreCodeableConcept | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: ValueSet dành cho Vaccine Code (required) | ||||
patient | SΣ | 1..1 | Reference(Patient Profile - VN Core R4) | Who was immunized | ||||
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 | SΣC | 1..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 | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | 1..1 | Reference(Encounter Profile - VN Core R4) | Encounter immunization was part of | |||||
occurrence[x] | SΣ | 1..1 | Vaccine administration date | |||||
occurrence[x]All Types | Content/Rules for all Types | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
data-absent-reason | S | 0..1 | code | occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||
occurrenceDateTime | dateTime | |||||||
occurrenceString | string | |||||||
recorded | S | 0..1 | dateTime | When the immunization was first captured in the subject's record | ||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
reportOrigin | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
location | S | 0..1 | Reference(Location | Location Profile - VN Core R4) | Where immunization occurred | ||||
manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer | ||||
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 | Σ | 1..1 | string | Text alternative for the resource | ||||
lotNumber | S | 0..1 | string | Vaccine lot number | ||||
expirationDate | S | 0..1 | date | Vaccine expiration date | ||||
site | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: Target Site - IPS (preferred) | ||||
route | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred) | ||||
doseQuantity | S | 0..1 | SimpleQuantity, SimpleQuantityIPS | 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 | Σ | 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 Profile - VN Core R4) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | S | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | ||||
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | ||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
subpotentReason | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
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..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
fundingSource | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
reaction | S | 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 | S | 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 | |||||
Slices for targetDisease | 0..* | VNCoreCodeableConcept | Vaccine preventatable disease being targetted Slice: Unordered, Open by pattern:$this Binding: Vaccine Target Diseases - IPS (preferred) | |||||
targetDisease:targetDiseaseGPSCode | S | 0..1 | CodeableConcept | Code for a disease the vaccination is against from the SNOMED CT GPS code set. Binding: ValueSet dành cho Mã bệnh tật (required) | ||||
doseNumber[x] | 1..1 | Dose number within series | ||||||
doseNumberPositiveInt | positiveInt | |||||||
doseNumberString | string | |||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
seriesDosesPositiveInt | positiveInt | |||||||
seriesDosesString | string | |||||||
Documentation for this format |
Profile này được dựa trên Resource ImmunizationUvIps
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Differential View
Profile này được dựa trên Resource ImmunizationUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | ImmunizationUvIps | |||
identifier | S | 0..* | Identifier | Business identifier |
statusReason | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text |
vaccineCode | 1..1 | VNCoreCodeableConcept | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. | |
Slices for vaccineCode | Content/Rules for all slices | |||
vaccineCode:vaccineCode | 0..1 | VNCoreCodeableConcept | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: ValueSet dành cho Vaccine Code (required) | |
patient | 1..1 | Reference(Patient Profile - VN Core R4) | Who was immunized | |
encounter | 1..1 | Reference(Encounter Profile - VN Core R4) | Encounter immunization was part of | |
recorded | S | 0..1 | dateTime | When the immunization was first captured in the subject's record |
reportOrigin | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
location | S | 0..1 | Reference(Location | Location Profile - VN Core R4) | Where immunization occurred |
manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer |
display | 1..1 | string | Text alternative for the resource | |
lotNumber | S | 0..1 | string | Vaccine lot number |
expirationDate | S | 0..1 | date | Vaccine expiration date |
site | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text |
route | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
doseQuantity | S | 0..1 | SimpleQuantity, SimpleQuantityIPS | Amount of vaccine administered |
performer | ||||
actor | 1..1 | Reference(Practitioner Profile - VN Core R4) | Individual or organization who was performing | |
reasonCode | S | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text |
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |
subpotentReason | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
programEligibility | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
fundingSource | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text | |
reaction | S | 0..* | BackboneElement | Details of a reaction that follows immunization |
protocolApplied | S | 0..* | BackboneElement | Protocol followed by the provider |
targetDisease | 0..* | VNCoreCodeableConcept | Vaccine preventatable disease being targetted | |
Slices for targetDisease | Content/Rules for all slices | |||
targetDisease:targetDiseaseGPSCode | 0..1 | CodeableConcept | Code for a disease the vaccination is against from the SNOMED CT GPS code set. Binding: ValueSet dành cho Mã bệnh tật (required) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | S | 0..* | ImmunizationUvIps | 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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier | Business identifier | ||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
statusReason | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | ||||
Slices for vaccineCode | SΣ | 1..1 | VNCoreCodeableConcept | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Slice: Unordered, Open by pattern:$this Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised. | ||||
vaccineCode:vaccineGPSCode | SΣ | 0..1 | CodeableConcept | Code for vaccine from the SNOMED CT GPS code set Binding: Vaccines (GPS) - IPS (required) | ||||
vaccineCode:atcClass | SΣ | 0..1 | CodeableConcept | WHO ATC classification Binding: WHO ATC - IPS (required) | ||||
vaccineCode:absentOrUnknownImmunization | SΣ | 0..1 | CodeableConcept | Absent Unknown Immunization Binding: Absent or Unknown Immunization - IPS (required) | ||||
vaccineCode:vaccineCode | SΣ | 0..1 | VNCoreCodeableConcept | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: ValueSet dành cho Vaccine Code (required) | ||||
patient | SΣ | 1..1 | Reference(Patient Profile - VN Core R4) | Who was immunized | ||||
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 | SΣC | 1..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 | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | 1..1 | Reference(Encounter Profile - VN Core R4) | Encounter immunization was part of | |||||
occurrence[x] | SΣ | 1..1 | Vaccine administration date | |||||
occurrence[x]All Types | Content/Rules for all Types | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
data-absent-reason | S | 0..1 | code | occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||
occurrenceDateTime | dateTime | |||||||
occurrenceString | string | |||||||
recorded | S | 0..1 | dateTime | When the immunization was first captured in the subject's record | ||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
reportOrigin | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
location | S | 0..1 | Reference(Location | Location Profile - VN Core R4) | Where immunization occurred | ||||
manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer | ||||
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 | Σ | 1..1 | string | Text alternative for the resource | ||||
lotNumber | S | 0..1 | string | Vaccine lot number | ||||
expirationDate | S | 0..1 | date | Vaccine expiration date | ||||
site | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: Target Site - IPS (preferred) | ||||
route | S | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred) | ||||
doseQuantity | S | 0..1 | SimpleQuantity, SimpleQuantityIPS | 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 | Σ | 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 Profile - VN Core R4) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | S | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | ||||
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | ||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
subpotentReason | 0..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
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..* | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
fundingSource | 0..1 | VNCoreCodeableConcept | Concept - reference to a terminology or just text Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
reaction | S | 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 | S | 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 | |||||
Slices for targetDisease | 0..* | VNCoreCodeableConcept | Vaccine preventatable disease being targetted Slice: Unordered, Open by pattern:$this Binding: Vaccine Target Diseases - IPS (preferred) | |||||
targetDisease:targetDiseaseGPSCode | S | 0..1 | CodeableConcept | Code for a disease the vaccination is against from the SNOMED CT GPS code set. Binding: ValueSet dành cho Mã bệnh tật (required) | ||||
doseNumber[x] | 1..1 | Dose number within series | ||||||
doseNumberPositiveInt | positiveInt | |||||||
doseNumberString | string | |||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
seriesDosesPositiveInt | positiveInt | |||||||
seriesDosesString | string | |||||||
Documentation for this format |
Hình thức mô tả khác: Schematron
Path | Conformance | ValueSet | URI | |||
Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | ||||
Immunization.vaccineCode | preferred | VaccinesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips | ||||
Immunization.vaccineCode:vaccineGPSCode | required | VaccinesGpsUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/vaccines-gps-uv-ips | ||||
Immunization.vaccineCode:atcClass | required | WhoAtcUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips | ||||
Immunization.vaccineCode:absentOrUnknownImmunization | required | NoImmunizationInfoUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips | ||||
Immunization.vaccineCode:vaccineCode | required | ValueSet-Vaccine_Administered_Codehttp://fhir.ehealth.gov.vn/core/ValueSet/vaccine-code from this IG | ||||
Immunization.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | ||||
Immunization.manufacturer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Immunization.site | preferred | TargetSiteCodeUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips | ||||
Immunization.route | preferred | RouteOfAdminUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | preferred | TargetDiseasesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-uv-ips | ||||
Immunization.protocolApplied.targetDisease:targetDiseaseGPSCode | required | ValueSet-VN_Core_Condition_Codehttp://fhir.ehealth.gov.vn/core/ValueSet/vn-core-condition-code from this IG |
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() |