Immunization
본 문서는 KR-CORE 에서 정의한 Resource 중 Immunization 의 대하여 설명한다.
목차
KR-CORE 1.0.1 기반의 구조의 대한 설명에 가까운 문서로, 세부적인 내용은 FHIR R4 기반의 Kr-core 을 참고해주세요.
Immunization
본 문서는 KR-Core 1.0.1 에서 정의한 Resource 중 Immunization 의 세부적인 기능을 설명하기 위한 문서입니다.
KRCore_Immunization (Immunization) | I | Immunization | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | 0..* | Identifier | |
status | S Σ ?! | 1..1 | codeBinding |
statusReason | 0..1 | CodeableConcept | |
vaccineCode | S Σ | 1..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..* | Coding |
VcntType | S Σ | 1..* | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
KDCode | Σ | 0..* | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
patient | Σ I | 1..1 | Reference(KRCore_Patient) |
encounter | I | 0..1 | Reference(Encounter) |
occurrence[x] | S Σ | 1..1 | |
occurrenceDateTime | dateTime | ||
recorded | 0..1 | dateTime | |
primarySource | Σ | 0..1 | boolean |
reportOrigin | 0..1 | CodeableConcept | |
location | I | 0..1 | Reference(Location) |
manufacturer | I | 0..1 | Reference(Organization) |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | date | |
site | 0..1 | CodeableConcept | |
route | 0..1 | CodeableConcept | |
doseQuantity | I | 0..1 | SimpleQuantity |
performer | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
function | Σ | 0..1 | CodeableConceptBinding |
actor | Σ I | 1..1 | Reference(Practitioner | PractitionerRole | Organization) |
note | Σ | 0..* | Annotation |
reasonCode | 0..* | CodeableConcept | |
reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport) |
isSubpotent | Σ ?! | 0..1 | boolean |
subpotentReason | 0..* | CodeableConcept | |
education | I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
documentType | 0..1 | string | |
reference | 0..1 | uri | |
publicationDate | 0..1 | dateTime | |
presentationDate | 0..1 | dateTime | |
programEligibility | 0..* | CodeableConcept | |
fundingSource | 0..1 | CodeableConcept | |
reaction | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
date | 0..1 | dateTime | |
detail | I | 0..1 | Reference(Observation) |
reported | 0..1 | boolean | |
protocolApplied | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
series | 0..1 | string | |
authority | I | 0..1 | Reference(Organization) |
targetDisease | 0..* | CodeableConcept | |
doseNumber[x] | 1..1 | ||
(All Slices) | |||
doseNumberString | string | ||
doseNumberPositiveInt | 0..1 | positiveInt | |
seriesDoses[x] | 0..1 | ||
seriesDosesPositiveInt | positiveInt | ||
seriesDosesString | string |
Immunization | |
Definition | Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Immunization.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Immunization.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Immunization.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Immunization.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Immunization.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Immunization.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Immunization.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.identifier | |
Definition | A unique identifier assigned to this immunization record. |
Cardinality | 0...* |
Type | Identifier |
Invariants |
|
Mappings |
|
Immunization.status | |
Definition | Indicates the current status of the immunization event. |
Cardinality | 1...1 |
Type | code |
Binding | A set of codes indicating the current status of an Immunization. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Examples | Value (Preferred) completed |
Mappings |
|
Immunization.statusReason | |
Definition | Indicates the reason the immunization event was not performed. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The reason why a vaccine was not administered. |
Comments | This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode | |
Definition | Vaccine that was administered or was to be administered. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The code for vaccine product administered. |
Must Support | True |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Immunization.vaccineCode.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:VcntType | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Binding | KR_Core_Vaccination_Type_Codes (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:VcntType.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Immunization.vaccineCode.coding:VcntType.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:VcntType.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types |
Mappings |
|
Immunization.vaccineCode.coding:VcntType.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:VcntType.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:VcntType.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:VcntType.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:KDCode | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | KR_Core_Korea_Drug_Codes (required) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:KDCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Immunization.vaccineCode.coding:KDCode.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:KDCode.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode |
Mappings |
|
Immunization.vaccineCode.coding:KDCode.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:KDCode.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:KDCode.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:KDCode.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Immunization.patient | |
Definition | The patient who either received or did not receive the immunization. |
Cardinality | 1...1 |
Type | Reference(KRCore_Patient) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Immunization.encounter | |
Definition | The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Immunization.occurrence[x] | |
Definition | Date vaccine administered or was to be administered. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose. |
Invariants |
|
Mappings |
|
Immunization.recorded | |
Definition | The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Immunization.primarySource | |
Definition | An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded. |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Comments | Reflects the “reliability” of the content. |
Invariants |
|
Mappings |
|
Immunization.reportOrigin | |
Definition | The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The source of the data for a record which is not from a primary source. |
Comments | Should not be populated if primarySource = True, not required even if primarySource = False. |
Invariants |
|
Mappings |
|
Immunization.location | |
Definition | The service delivery location where the vaccine administration occurred. |
Cardinality | 0...1 |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Immunization.manufacturer | |
Definition | Name of vaccine manufacturer. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Immunization.lotNumber | |
Definition | Lot number of the vaccine product. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Immunization.expirationDate | |
Definition | Date vaccine batch expires. |
Cardinality | 0...1 |
Type | date |
Invariants |
|
Mappings |
|
Immunization.site | |
Definition | Body site where vaccine was administered. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The site at which the vaccine was administered. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Immunization.route | |
Definition | The path by which the vaccine product is taken into the body. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The route by which the vaccine was administered. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Immunization.doseQuantity | |
Definition | The quantity of vaccine product that was administered. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Immunization.performer | |
Definition | Indicates who performed the immunization event. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
Immunization.performer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Immunization.performer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.performer.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.performer.function | |
Definition | Describes the type of performance (e.g. ordering provider, administering provider, etc.). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The role a practitioner or organization plays in the immunization event. |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Immunization.performer.actor | |
Definition | The practitioner or organization who performed the action. |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Summary | True |
Comments | When the individual practitioner who performed the action is known, it is best to send. |
Invariants |
|
Mappings |
|
Immunization.note | |
Definition | Extra information about the immunization that is not conveyed by the other attributes. |
Cardinality | 0...* |
Type | Annotation |
Summary | True |
Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
Invariants |
|
Mappings |
|
Immunization.reasonCode | |
Definition | Reasons why the vaccine was administered. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason why a vaccine was administered. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Immunization.reasonReference | |
Definition | Condition, Observation or DiagnosticReport that supports why the immunization was administered. |
Cardinality | 0...* |
Type | Reference(Condition | Observation | DiagnosticReport) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Immunization.isSubpotent | |
Definition | Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Comments | Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event. |
Invariants |
|
Mappings |
|
Immunization.subpotentReason | |
Definition | Reason why a dose is considered to be subpotent. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason why a dose is considered to be subpotent. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Immunization.education | |
Definition | Educational material presented to the patient (or guardian) at the time of vaccine administration. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Immunization.education.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Immunization.education.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.education.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.education.documentType | |
Definition | Identifier of the material presented to the patient. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Immunization.education.reference | |
Definition | Reference pointer to the educational material given to the patient if the information was on line. |
Cardinality | 0...1 |
Type | uri |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Immunization.education.publicationDate | |
Definition | Date the educational material was published. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Immunization.education.presentationDate | |
Definition | Date the educational material was given to the patient. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Immunization.programEligibility | |
Definition | Indicates a patient's eligibility for a funding program. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The patient's eligibility for a vaccation program. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Immunization.fundingSource | |
Definition | Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The source of funding used to purchase the vaccine administered. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Immunization.reaction | |
Definition | Categorical data indicating that an adverse event is associated in time to an immunization. |
Cardinality | 0...* |
Type | BackboneElement |
Comments | A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements. |
Invariants |
|
Mappings |
|
Immunization.reaction.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Immunization.reaction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.reaction.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.reaction.date | |
Definition | Date of reaction to the immunization. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Immunization.reaction.detail | |
Definition | Details of the reaction. |
Cardinality | 0...1 |
Type | Reference(Observation) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Immunization.reaction.reported | |
Definition | Self-reported indicator. |
Cardinality | 0...1 |
Type | boolean |
Invariants |
|
Mappings |
|
Immunization.protocolApplied | |
Definition | The protocol (set of recommendations) being followed by the provider who administered the dose. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Immunization.protocolApplied.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.series | |
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.authority | |
Definition | Indicates the authority who published the protocol (e.g. ACIP) that is being followed. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.targetDisease | |
Definition | The vaccine preventable disease the dose is being administered against. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The vaccine preventable disease the dose is being administered for. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.doseNumber[x] | |
Definition | Nominal position in a series. |
Cardinality | 1...1 |
Type | positiveInt |
Comments | The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt | |
Definition | Nominal position in a series. |
Cardinality | 0...1 |
Type | positiveInt |
Comments | The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.seriesDoses[x] | |
Definition | The recommended number of doses to achieve immunity. |
Cardinality | 0...1 |
Type | positiveInt |
Comments | The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="krcore-immunization" /> <text> <status value="extensions" /> --- We have skipped the narrative for better readability of the resource --- </text> <url value="http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization" /> <version value="1.0.1" /> <name value="KRCore_Immunization" /> <title value="KR Core Immunization Profile" /> <status value="active" /> <date value="2023-06-30T13:42:49+09:00" /> <publisher value="HL7 Korea" /> <contact> <name value="HL7 Korea" /> <telecom> <system value="url" /> <value value="http://www.hl7korea.or.kr/" /> </telecom> <telecom> <system value="email" /> <value value="contact@healthall.co.kr" /> </telecom> </contact> <contact> <name value="HealthAll Inc." /> <telecom> <system value="email" /> <value value="contact@healthall.co.kr" /> <use value="work" /> </telecom> </contact> <description value="KR Core의 예방 접종 정보에 적용되는 Immunization 구조." /> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166" /> <code value="KR" /> <display value="Korea, Republic of" /> </coding> </jurisdiction> <fhirVersion value="4.0.1" /> <mapping> <identity value="workflow" /> <uri value="http://hl7.org/fhir/workflow" /> <name value="Workflow Pattern" /> </mapping> <mapping> <identity value="v2" /> <uri value="http://hl7.org/v2" /> <name value="HL7 v2 Mapping" /> </mapping> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <mapping> <identity value="w5" /> <uri value="http://hl7.org/fhir/fivews" /> <name value="FiveWs Pattern Mapping" /> </mapping> <mapping> <identity value="cda" /> <uri value="http://hl7.org/v3/cda" /> <name value="CDA (R2)" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Immunization" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Immunization" /> <derivation value="constraint" /> <snapshot> <element id="Immunization"> <path value="Immunization" /> <short value="KR Core Immunization Profile" /> <definition value="Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization" /> <min value="0" /> <max value="*" /> </base> <constraint> <key value="dom-2" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" /> <expression value="contained.contained.empty()" /> <xpath value="not(parent::f:contained and f:contained)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-3" /> <severity value="error" /> <human value="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" /> <expression value="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()" /> <xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-4" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" /> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-5" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a security label" /> <expression value="contained.meta.security.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:security))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"> <valueBoolean value="true" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation"> <valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." /> </extension> <key value="dom-6" /> <severity value="warning" /> <human value="A resource should have narrative for robust management" /> <expression value="text.`div`.exists()" /> <xpath value="exists(f:text/h:div)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="workflow" /> <map value="Event" /> </mapping> <mapping> <identity value="v2" /> <map value="VXU_V04" /> </mapping> <mapping> <identity value="rim" /> <map value="SubstanceAdministration" /> </mapping> </element> <element id="Immunization.id"> <path value="Immunization.id" /> <short value="Logical id of this artifact" /> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="id" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Immunization.meta"> <path value="Immunization.meta" /> <short value="Metadata about the resource" /> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.meta" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Meta" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Immunization.implicitRules"> <path value="Immunization.implicitRules" /> <short value="A set of rules under which this content was created" /> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." /> <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.implicitRules" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" /> <isSummary value="true" /> </element> <element id="Immunization.language"> <path value="Immunization.language" /> <short value="Language of the resource content" /> <definition value="The base language in which the resource is written." /> <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.language" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="preferred" /> <description value="A human language." /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> </element> <element id="Immunization.text"> <path value="Immunization.text" /> <short value="Text summary of the resource, for human interpretation" /> <definition value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." /> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later." /> <alias value="narrative" /> <alias value="html" /> <alias value="xhtml" /> <alias value="display" /> <min value="0" /> <max value="1" /> <base> <path value="DomainResource.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Narrative" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="Act.text?" /> </mapping> </element> <element id="Immunization.contained"> <path value="Immunization.contained" /> <short value="Contained, inline Resources" /> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." /> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels." /> <alias value="inline resources" /> <alias value="anonymous resources" /> <alias value="contained resources" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.contained" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Resource" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.extension"> <path value="Immunization.extension" /> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.modifierExtension"> <path value="Immunization.modifierExtension" /> <short value="Extensions that cannot be ignored" /> <definition value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.identifier"> <path value="Immunization.identifier" /> <short value="Business identifier" /> <definition value="A unique identifier assigned to this immunization record." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.identifier" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="workflow" /> <map value="Event.identifier" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.identifier" /> </mapping> <mapping> <identity value="rim" /> <map value=".id" /> </mapping> <mapping> <identity value="cda" /> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id" /> </mapping> </element> <element id="Immunization.status"> <path value="Immunization.status" /> <short value="예방 접종 상태: completed | entered-in-error | not-done" /> <definition value="Indicates the current status of the immunization event." /> <comment value="Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid." /> <min value="1" /> <max value="1" /> <base> <path value="Immunization.status" /> <min value="1" /> <max value="1" /> </base> <type> <code value="code" /> </type> <example> <label value="Value (Preferred)" /> <valueCode value="completed" /> </example> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="true" /> <isModifierReason value="This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationStatus" /> </extension> <strength value="required" /> <description value="A set of codes indicating the current status of an Immunization." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-status|4.0.1" /> </binding> <mapping> <identity value="workflow" /> <map value="Event.status" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.status" /> </mapping> <mapping> <identity value="rim" /> <map value="statusCode" /> </mapping> </element> <element id="Immunization.statusReason"> <path value="Immunization.statusReason" /> <short value="Reason not done" /> <definition value="Indicates the reason the immunization event was not performed." /> <comment value="This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.statusReason" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationStatusReason" /> </extension> <strength value="example" /> <description value="The reason why a vaccine was not administered." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-status-reason" /> </binding> <mapping> <identity value="workflow" /> <map value="Event.statusReason" /> </mapping> <mapping> <identity value="rim" /> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" /> </mapping> </element> <element id="Immunization.vaccineCode"> <path value="Immunization.vaccineCode" /> <short value="예방접종 식별 코드" /> <definition value="Vaccine that was administered or was to be administered." /> <min value="1" /> <max value="1" /> <base> <path value="Immunization.vaccineCode" /> <min value="1" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="false" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="VaccineCode" /> </extension> <strength value="example" /> <description value="The code for vaccine product administered." /> <valueSet value="http://hl7.org/fhir/ValueSet/vaccine-code" /> </binding> <mapping> <identity value="workflow" /> <map value="Event.code" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.what[x]" /> </mapping> <mapping> <identity value="v2" /> <map value="RXA-5" /> </mapping> <mapping> <identity value="rim" /> <map value=".code" /> </mapping> <mapping> <identity value="cda" /> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code" /> </mapping> </element> <element id="Immunization.vaccineCode.id"> <path value="Immunization.vaccineCode.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.vaccineCode.extension"> <path value="Immunization.vaccineCode.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.vaccineCode.coding"> <path value="Immunization.vaccineCode.coding" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <short value="Code defined by a terminology system" /> <definition value="A reference to a code defined by a terminology system." /> <comment value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true." /> <requirements value="Allows for alternative encodings within a code system, and translations to other code systems." /> <min value="1" /> <max value="*" /> <base> <path value="CodeableConcept.coding" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Coding" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.1-8, C*E.10-22" /> </mapping> <mapping> <identity value="rim" /> <map value="union(., ./translation)" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:VcntType"> <path value="Immunization.vaccineCode.coding" /> <sliceName value="VcntType" /> <short value="예방접종 분류" /> <definition value="A reference to a code defined by a terminology system." /> <comment value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true." /> <requirements value="Allows for alternative encodings within a code system, and translations to other code systems." /> <min value="1" /> <max value="*" /> <base> <path value="CodeableConcept.coding" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Coding" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="false" /> <isSummary value="true" /> <binding> <strength value="required" /> <valueSet value="http://www.hl7korea.or.kr/fhir/krcore/ValueSet/krcore-vcnt-type-codes" /> </binding> <mapping> <identity value="v2" /> <map value="C*E.1-8, C*E.10-22" /> </mapping> <mapping> <identity value="rim" /> <map value="union(., ./translation)" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:VcntType.id"> <path value="Immunization.vaccineCode.coding.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:VcntType.extension"> <path value="Immunization.vaccineCode.coding.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:VcntType.system"> <path value="Immunization.vaccineCode.coding.system" /> <short value="예방접종 분류 코드체계" /> <definition value="The identification of the code system that defines the meaning of the symbol in the code." /> <comment value="The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously." /> <requirements value="Need to be unambiguous about the source of the definition of the symbol." /> <min value="1" /> <max value="1" /> <base> <path value="Coding.system" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <fixedUri value="http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.3" /> </mapping> <mapping> <identity value="rim" /> <map value="./codeSystem" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:VcntType.version"> <path value="Immunization.vaccineCode.coding.version" /> <short value="Version of the system - if relevant" /> <definition value="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged." /> <comment value="Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date." /> <min value="0" /> <max value="1" /> <base> <path value="Coding.version" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.7" /> </mapping> <mapping> <identity value="rim" /> <map value="./codeSystemVersion" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:VcntType.code"> <path value="Immunization.vaccineCode.coding.code" /> <short value="예방접종 분류 코드" /> <definition value="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)." /> <requirements value="Need to refer to a particular code in the system." /> <min value="1" /> <max value="1" /> <base> <path value="Coding.code" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.1" /> </mapping> <mapping> <identity value="rim" /> <map value="./code" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:VcntType.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true" /> </extension> <path value="Immunization.vaccineCode.coding.display" /> <short value="Representation defined by the system" /> <definition value="A representation of the meaning of the code in the system, following the rules of the system." /> <requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system." /> <min value="0" /> <max value="1" /> <base> <path value="Coding.display" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.2 - but note this is not well followed" /> </mapping> <mapping> <identity value="rim" /> <map value="CV.displayName" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:VcntType.userSelected"> <path value="Immunization.vaccineCode.coding.userSelected" /> <short value="If this coding was chosen directly by the user" /> <definition value="Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays)." /> <comment value="Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely." /> <requirements value="This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing." /> <min value="0" /> <max value="1" /> <base> <path value="Coding.userSelected" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="Sometimes implied by being first" /> </mapping> <mapping> <identity value="rim" /> <map value="CD.codingRationale" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:KDCode"> <path value="Immunization.vaccineCode.coding" /> <sliceName value="KDCode" /> <short value="식품의약품안전처 의약품표준 코드 정보" /> <definition value="A reference to a code defined by a terminology system." /> <comment value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true." /> <requirements value="Allows for alternative encodings within a code system, and translations to other code systems." /> <min value="0" /> <max value="*" /> <base> <path value="CodeableConcept.coding" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Coding" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <binding> <strength value="required" /> <valueSet value="http://www.hl7korea.or.kr/fhir/krcore/ValueSet/krcore-korea-drug-codes" /> </binding> <mapping> <identity value="v2" /> <map value="C*E.1-8, C*E.10-22" /> </mapping> <mapping> <identity value="rim" /> <map value="union(., ./translation)" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:KDCode.id"> <path value="Immunization.vaccineCode.coding.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:KDCode.extension"> <path value="Immunization.vaccineCode.coding.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:KDCode.system"> <path value="Immunization.vaccineCode.coding.system" /> <short value="식품의약품안전처 의약품표준 코드체계" /> <definition value="The identification of the code system that defines the meaning of the symbol in the code." /> <comment value="The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously." /> <requirements value="Need to be unambiguous about the source of the definition of the symbol." /> <min value="1" /> <max value="1" /> <base> <path value="Coding.system" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <fixedUri value="http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.3" /> </mapping> <mapping> <identity value="rim" /> <map value="./codeSystem" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:KDCode.version"> <path value="Immunization.vaccineCode.coding.version" /> <short value="Version of the system - if relevant" /> <definition value="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged." /> <comment value="Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date." /> <min value="0" /> <max value="1" /> <base> <path value="Coding.version" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.7" /> </mapping> <mapping> <identity value="rim" /> <map value="./codeSystemVersion" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:KDCode.code"> <path value="Immunization.vaccineCode.coding.code" /> <short value="식품의약품안전처 의약품표준 코드" /> <definition value="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)." /> <requirements value="Need to refer to a particular code in the system." /> <min value="1" /> <max value="1" /> <base> <path value="Coding.code" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.1" /> </mapping> <mapping> <identity value="rim" /> <map value="./code" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:KDCode.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true" /> </extension> <path value="Immunization.vaccineCode.coding.display" /> <short value="Representation defined by the system" /> <definition value="A representation of the meaning of the code in the system, following the rules of the system." /> <requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system." /> <min value="0" /> <max value="1" /> <base> <path value="Coding.display" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.2 - but note this is not well followed" /> </mapping> <mapping> <identity value="rim" /> <map value="CV.displayName" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:KDCode.userSelected"> <path value="Immunization.vaccineCode.coding.userSelected" /> <short value="If this coding was chosen directly by the user" /> <definition value="Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays)." /> <comment value="Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely." /> <requirements value="This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing." /> <min value="0" /> <max value="1" /> <base> <path value="Coding.userSelected" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="Sometimes implied by being first" /> </mapping> <mapping> <identity value="rim" /> <map value="CD.codingRationale" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" /> </mapping> </element> <element id="Immunization.vaccineCode.text"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true" /> </extension> <path value="Immunization.vaccineCode.text" /> <short value="Plain text representation of the concept" /> <definition value="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user." /> <comment value="Very often the text is the same as a displayName of one of the codings." /> <requirements value="The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source." /> <min value="0" /> <max value="1" /> <base> <path value="CodeableConcept.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.9. But note many systems use C*E.2 for this" /> </mapping> <mapping> <identity value="rim" /> <map value="./originalText[mediaType/code="text/plain"]/data" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" /> </mapping> </element> <element id="Immunization.patient"> <path value="Immunization.patient" /> <short value="예방 접종 대상" /> <definition value="The patient who either received or did not receive the immunization." /> <min value="1" /> <max value="1" /> <base> <path value="Immunization.patient" /> <min value="1" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="workflow" /> <map value="Event.subject" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.subject[x]" /> </mapping> <mapping> <identity value="v2" /> <map value="PID-3" /> </mapping> <mapping> <identity value="rim" /> <map value=".partipication[ttypeCode=].role" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.subject" /> </mapping> </element> <element id="Immunization.encounter"> <path value="Immunization.encounter" /> <short value="Encounter immunization was part of" /> <definition value="The visit or admission or other contact between patient and health care provider the immunization was performed as part of." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.encounter" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="workflow" /> <map value="Event.context" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.context" /> </mapping> <mapping> <identity value="v2" /> <map value="PV1-19" /> </mapping> <mapping> <identity value="rim" /> <map value="component->EncounterEvent" /> </mapping> </element> <element id="Immunization.occurrence[x]"> <path value="Immunization.occurrence[x]" /> <short value="예방 접종 일시" /> <definition value="Date vaccine administered or was to be administered." /> <comment value="When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose." /> <min value="1" /> <max value="1" /> <base> <path value="Immunization.occurrence[x]" /> <min value="1" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="workflow" /> <map value="Event.occurrence[x]" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.done[x]" /> </mapping> <mapping> <identity value="v2" /> <map value="RXA-3" /> </mapping> <mapping> <identity value="rim" /> <map value=".effectiveTime" /> </mapping> <mapping> <identity value="cda" /> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value" /> </mapping> </element> <element id="Immunization.recorded"> <path value="Immunization.recorded" /> <short value="When the immunization was first captured in the subject's record" /> <definition value="The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.recorded" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="w5" /> <map value="FiveWs.recorded" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=AUT].time" /> </mapping> </element> <element id="Immunization.primarySource"> <path value="Immunization.primarySource" /> <short value="Indicates context the data was recorded in" /> <definition value="An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded." /> <comment value="Reflects the “reliability” of the content." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.primarySource" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="w5" /> <map value="FiveWs.source" /> </mapping> <mapping> <identity value="v2" /> <map value="RXA-9" /> </mapping> <mapping> <identity value="rim" /> <map value="immunization.uncertaintycode (if primary source=false, uncertainty=U)" /> </mapping> </element> <element id="Immunization.reportOrigin"> <path value="Immunization.reportOrigin" /> <short value="Indicates the source of a secondarily reported record" /> <definition value="The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine." /> <comment value="Should not be populated if primarySource = True, not required even if primarySource = False." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.reportOrigin" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationReportOrigin" /> </extension> <strength value="example" /> <description value="The source of the data for a record which is not from a primary source." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-origin" /> </binding> <mapping> <identity value="w5" /> <map value="FiveWs.source" /> </mapping> <mapping> <identity value="v2" /> <map value="RXA-9" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)" /> </mapping> </element> <element id="Immunization.location"> <path value="Immunization.location" /> <short value="Where immunization occurred" /> <definition value="The service delivery location where the vaccine administration occurred." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.location" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Location" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="workflow" /> <map value="Event.location" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.where[x]" /> </mapping> <mapping> <identity value="v2" /> <map value="RXA-27 (or RXA-11, deprecated as of v2.7)" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=LOC].COCT_MT240000UV" /> </mapping> </element> <element id="Immunization.manufacturer"> <path value="Immunization.manufacturer" /> <short value="Vaccine manufacturer" /> <definition value="Name of vaccine manufacturer." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.manufacturer" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="RXA-17" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]" /> </mapping> <mapping> <identity value="cda" /> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name" /> </mapping> </element> <element id="Immunization.lotNumber"> <path value="Immunization.lotNumber" /> <short value="Vaccine lot number" /> <definition value="Lot number of the vaccine product." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.lotNumber" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="RXA-15" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id" /> </mapping> <mapping> <identity value="cda" /> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText" /> </mapping> </element> <element id="Immunization.expirationDate"> <path value="Immunization.expirationDate" /> <short value="Vaccine expiration date" /> <definition value="Date vaccine batch expires." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.expirationDate" /> <min value="0" /> <max value="1" /> </base> <type> <code value="date" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="RXA-16" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime" /> </mapping> </element> <element id="Immunization.site"> <path value="Immunization.site" /> <short value="Body site vaccine was administered" /> <definition value="Body site where vaccine was administered." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.site" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationSite" /> </extension> <strength value="example" /> <description value="The site at which the vaccine was administered." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-site" /> </binding> <mapping> <identity value="v2" /> <map value="RXR-2" /> </mapping> <mapping> <identity value="rim" /> <map value="observation.targetSiteCode" /> </mapping> <mapping> <identity value="cda" /> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code" /> </mapping> </element> <element id="Immunization.route"> <path value="Immunization.route" /> <short value="How vaccine entered body" /> <definition value="The path by which the vaccine product is taken into the body." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.route" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationRoute" /> </extension> <strength value="example" /> <description value="The route by which the vaccine was administered." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-route" /> </binding> <mapping> <identity value="v2" /> <map value="RXR-1" /> </mapping> <mapping> <identity value="rim" /> <map value=".routeCode" /> </mapping> <mapping> <identity value="cda" /> <map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code" /> </mapping> </element> <element id="Immunization.doseQuantity"> <path value="Immunization.doseQuantity" /> <short value="Amount of vaccine administered" /> <definition value="The quantity of vaccine product that was administered." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.doseQuantity" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Quantity" /> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="RXA-6 / RXA-7" /> </mapping> <mapping> <identity value="rim" /> <map value=".doseQuantity" /> </mapping> </element> <element id="Immunization.performer"> <path value="Immunization.performer" /> <short value="Who performed event" /> <definition value="Indicates who performed the immunization event." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.performer" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="workflow" /> <map value="Event.performer" /> </mapping> <mapping> <identity value="v2" /> <map value="ORC-12 / RXA-10" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" /> </mapping> </element> <element id="Immunization.performer.id"> <path value="Immunization.performer.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.performer.extension"> <path value="Immunization.performer.extension" /> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.performer.modifierExtension"> <path value="Immunization.performer.modifierExtension" /> <short value="Extensions that cannot be ignored even if unrecognized" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.performer.function"> <path value="Immunization.performer.function" /> <short value="What type of performance was done" /> <definition value="Describes the type of performance (e.g. ordering provider, administering provider, etc.)." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.performer.function" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationFunction" /> </extension> <strength value="extensible" /> <description value="The role a practitioner or organization plays in the immunization event." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-function" /> </binding> <mapping> <identity value="workflow" /> <map value="Event.performer.function" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation.functionCode" /> </mapping> </element> <element id="Immunization.performer.actor"> <path value="Immunization.performer.actor" /> <short value="Individual or organization who was performing" /> <definition value="The practitioner or organization who performed the action." /> <comment value="When the individual practitioner who performed the action is known, it is best to send." /> <min value="1" /> <max value="1" /> <base> <path value="Immunization.performer.actor" /> <min value="1" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="workflow" /> <map value="Event.performer.actor" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.actor" /> </mapping> <mapping> <identity value="rim" /> <map value=".player" /> </mapping> </element> <element id="Immunization.note"> <path value="Immunization.note" /> <short value="Additional immunization notes" /> <definition value="Extra information about the immunization that is not conveyed by the other attributes." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.note" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Annotation" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="workflow" /> <map value="Event.note" /> </mapping> <mapping> <identity value="v2" /> <map value="OBX-5 : OBX-3 = 48767-8" /> </mapping> <mapping> <identity value="rim" /> <map value="note" /> </mapping> </element> <element id="Immunization.reasonCode"> <path value="Immunization.reasonCode" /> <short value="Why immunization occurred" /> <definition value="Reasons why the vaccine was administered." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.reasonCode" /> <min value="0" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ImmunizationReason" /> </extension> <strength value="example" /> <description value="The reason why a vaccine was administered." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-reason" /> </binding> <mapping> <identity value="workflow" /> <map value="Event.reasonCode" /> </mapping> <mapping> <identity value="rim" /> <map value="[actionNegationInd=false].reasonCode" /> </mapping> </element> <element id="Immunization.reasonReference"> <path value="Immunization.reasonReference" /> <short value="Why immunization occurred" /> <definition value="Condition, Observation or DiagnosticReport that supports why the immunization was administered." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.reasonReference" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="workflow" /> <map value="Event.reasonReference" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.isSubpotent"> <path value="Immunization.isSubpotent" /> <short value="Dose potency" /> <definition value="Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent." /> <comment value="Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.isSubpotent" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <meaningWhenMissing value="By default, a dose should be considered to be potent." /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose." /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="RXA-20 = PA (partial administration)" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.subpotentReason"> <path value="Immunization.subpotentReason" /> <short value="Reason for being subpotent" /> <definition value="Reason why a dose is considered to be subpotent." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.subpotentReason" /> <min value="0" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubpotentReason" /> </extension> <strength value="example" /> <description value="The reason why a dose is considered to be subpotent." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-subpotent-reason" /> </binding> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.education"> <path value="Immunization.education" /> <short value="Educational material presented to patient" /> <definition value="Educational material presented to the patient (or guardian) at the time of vaccine administration." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.education" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="imm-1" /> <severity value="error" /> <human value="One of documentType or reference SHALL be present" /> <expression value="documentType.exists() or reference.exists()" /> <xpath value="exists(f:documentType) or exists(f:reference)" /> <source value="http://hl7.org/fhir/StructureDefinition/Immunization" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.education.id"> <path value="Immunization.education.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.education.extension"> <path value="Immunization.education.extension" /> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.education.modifierExtension"> <path value="Immunization.education.modifierExtension" /> <short value="Extensions that cannot be ignored even if unrecognized" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.education.documentType"> <path value="Immunization.education.documentType" /> <short value="Educational material document identifier" /> <definition value="Identifier of the material presented to the patient." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.education.documentType" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="OBX-5 : OBX-3 = 69764-9" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.education.reference"> <path value="Immunization.education.reference" /> <short value="Educational material reference pointer" /> <definition value="Reference pointer to the educational material given to the patient if the information was on line." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.education.reference" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.education.publicationDate"> <path value="Immunization.education.publicationDate" /> <short value="Educational material publication date" /> <definition value="Date the educational material was published." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.education.publicationDate" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="OBX-5 : OBX-3 = 29768-9" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.education.presentationDate"> <path value="Immunization.education.presentationDate" /> <short value="Educational material presentation date" /> <definition value="Date the educational material was given to the patient." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.education.presentationDate" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="OBX-5 : OBX-3 = 29769-7" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.programEligibility"> <path value="Immunization.programEligibility" /> <short value="Patient eligibility for a vaccination program" /> <definition value="Indicates a patient's eligibility for a funding program." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.programEligibility" /> <min value="0" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ProgramEligibility" /> </extension> <strength value="example" /> <description value="The patient's eligibility for a vaccation program." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-program-eligibility" /> </binding> <mapping> <identity value="v2" /> <map value="OBX-5 : OBX-3 = 64994-7" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.fundingSource"> <path value="Immunization.fundingSource" /> <short value="Funding source for the vaccine" /> <definition value="Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered)." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.fundingSource" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="FundingSource" /> </extension> <strength value="example" /> <description value="The source of funding used to purchase the vaccine administered." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-funding-source" /> </binding> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.reaction"> <path value="Immunization.reaction" /> <short value="Details of a reaction that follows immunization" /> <definition value="Categorical data indicating that an adverse event is associated in time to an immunization." /> <comment value="A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.reaction" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="OBX-3" /> </mapping> <mapping> <identity value="rim" /> <map value="Observation[classCode=obs].code" /> </mapping> </element> <element id="Immunization.reaction.id"> <path value="Immunization.reaction.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.reaction.extension"> <path value="Immunization.reaction.extension" /> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.reaction.modifierExtension"> <path value="Immunization.reaction.modifierExtension" /> <short value="Extensions that cannot be ignored even if unrecognized" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.reaction.date"> <path value="Immunization.reaction.date" /> <short value="When reaction started" /> <definition value="Date of reaction to the immunization." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.reaction.date" /> <min value="0" /> <max value="1" /> </base> <type> <code value="dateTime" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)" /> </mapping> <mapping> <identity value="rim" /> <map value=".effectiveTime" /> </mapping> </element> <element id="Immunization.reaction.detail"> <path value="Immunization.reaction.detail" /> <short value="Additional information on reaction" /> <definition value="Details of the reaction." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.reaction.detail" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="OBX-5" /> </mapping> <mapping> <identity value="rim" /> <map value=".value" /> </mapping> </element> <element id="Immunization.reaction.reported"> <path value="Immunization.reaction.reported" /> <short value="Indicates self-reported reaction" /> <definition value="Self-reported indicator." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.reaction.reported" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="(HL7 v2 doesn't seem to provide for this)" /> </mapping> <mapping> <identity value="rim" /> <map value=".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)" /> </mapping> </element> <element id="Immunization.protocolApplied"> <path value="Immunization.protocolApplied" /> <short value="예방 접종 프로토콜" /> <definition value="The protocol (set of recommendations) being followed by the provider who administered the dose." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.protocolApplied" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.protocolApplied.id"> <path value="Immunization.protocolApplied.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.protocolApplied.extension"> <path value="Immunization.protocolApplied.extension" /> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Immunization.protocolApplied.modifierExtension"> <path value="Immunization.protocolApplied.modifierExtension" /> <short value="Extensions that cannot be ignored even if unrecognized" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.protocolApplied.series"> <path value="Immunization.protocolApplied.series" /> <short value="Name of vaccine series" /> <definition value="One possible path to achieve presumed immunity against a disease - within the context of an authority." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.protocolApplied.series" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.protocolApplied.authority"> <path value="Immunization.protocolApplied.authority" /> <short value="Who is responsible for publishing the recommendations" /> <definition value="Indicates the authority who published the protocol (e.g. ACIP) that is being followed." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.protocolApplied.authority" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.protocolApplied.targetDisease"> <path value="Immunization.protocolApplied.targetDisease" /> <short value="Vaccine preventatable disease being targetted" /> <definition value="The vaccine preventable disease the dose is being administered against." /> <min value="0" /> <max value="*" /> <base> <path value="Immunization.protocolApplied.targetDisease" /> <min value="0" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="TargetDisease" /> </extension> <strength value="example" /> <description value="The vaccine preventable disease the dose is being administered for." /> <valueSet value="http://hl7.org/fhir/ValueSet/immunization-target-disease" /> </binding> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.protocolApplied.doseNumber[x]"> <path value="Immunization.protocolApplied.doseNumber[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> <short value="Dose number within series" /> <definition value="Nominal position in a series." /> <comment value="The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose)." /> <min value="1" /> <max value="1" /> <base> <path value="Immunization.protocolApplied.doseNumber[x]" /> <min value="1" /> <max value="1" /> </base> <type> <code value="positiveInt" /> </type> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt"> <path value="Immunization.protocolApplied.doseNumber[x]" /> <sliceName value="doseNumberPositiveInt" /> <short value="예방 접종 차수" /> <definition value="Nominal position in a series." /> <comment value="The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose)." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.protocolApplied.doseNumber[x]" /> <min value="1" /> <max value="1" /> </base> <type> <code value="positiveInt" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Immunization.protocolApplied.seriesDoses[x]"> <path value="Immunization.protocolApplied.seriesDoses[x]" /> <short value="Recommended number of doses for immunity" /> <definition value="The recommended number of doses to achieve immunity." /> <comment value="The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose)." /> <min value="0" /> <max value="1" /> <base> <path value="Immunization.protocolApplied.seriesDoses[x]" /> <min value="0" /> <max value="1" /> </base> <type> <code value="positiveInt" /> </type> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> </snapshot> <differential> <element id="Immunization"> <path value="Immunization" /> <short value="KR Core Immunization Profile" /> </element> <element id="Immunization.status"> <path value="Immunization.status" /> <short value="예방 접종 상태: completed | entered-in-error | not-done" /> <example> <label value="Value (Preferred)" /> <valueCode value="completed" /> </example> <mustSupport value="true" /> </element> <element id="Immunization.vaccineCode"> <path value="Immunization.vaccineCode" /> <short value="예방접종 식별 코드" /> <mustSupport value="true" /> </element> <element id="Immunization.vaccineCode.coding"> <path value="Immunization.vaccineCode.coding" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> </element> <element id="Immunization.vaccineCode.coding:VcntType"> <path value="Immunization.vaccineCode.coding" /> <sliceName value="VcntType" /> <short value="예방접종 분류" /> <min value="1" /> <max value="*" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://www.hl7korea.or.kr/fhir/krcore/ValueSet/krcore-vcnt-type-codes" /> </binding> </element> <element id="Immunization.vaccineCode.coding:VcntType.system"> <path value="Immunization.vaccineCode.coding.system" /> <short value="예방접종 분류 코드체계" /> <min value="1" /> <fixedUri value="http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types" /> <mustSupport value="true" /> </element> <element id="Immunization.vaccineCode.coding:VcntType.code"> <path value="Immunization.vaccineCode.coding.code" /> <short value="예방접종 분류 코드" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Immunization.vaccineCode.coding:KDCode"> <path value="Immunization.vaccineCode.coding" /> <sliceName value="KDCode" /> <short value="식품의약품안전처 의약품표준 코드 정보" /> <min value="0" /> <max value="*" /> <binding> <strength value="required" /> <valueSet value="http://www.hl7korea.or.kr/fhir/krcore/ValueSet/krcore-korea-drug-codes" /> </binding> </element> <element id="Immunization.vaccineCode.coding:KDCode.system"> <path value="Immunization.vaccineCode.coding.system" /> <short value="식품의약품안전처 의약품표준 코드체계" /> <min value="1" /> <fixedUri value="http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode" /> </element> <element id="Immunization.vaccineCode.coding:KDCode.code"> <path value="Immunization.vaccineCode.coding.code" /> <short value="식품의약품안전처 의약품표준 코드" /> <min value="1" /> </element> <element id="Immunization.patient"> <path value="Immunization.patient" /> <short value="예방 접종 대상" /> <type> <code value="Reference" /> <targetProfile value="http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" /> </type> </element> <element id="Immunization.occurrence[x]"> <path value="Immunization.occurrence[x]" /> <short value="예방 접종 일시" /> <type> <code value="dateTime" /> </type> <mustSupport value="true" /> </element> <element id="Immunization.protocolApplied"> <path value="Immunization.protocolApplied" /> <short value="예방 접종 프로토콜" /> </element> <element id="Immunization.protocolApplied.doseNumberPositiveInt"> <path value="Immunization.protocolApplied.doseNumberPositiveInt" /> <short value="예방 접종 차수" /> <min value="0" /> <max value="1" /> <type> <code value="positiveInt" /> </type> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "krcore-immunization", "text": { "status": "extensions", --- We have skipped the narrative for better readability of the resource --- }, "url": "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-immunization", "version": "1.0.1", "name": "KRCore_Immunization", "title": "KR Core Immunization Profile", "status": "active", "date": "2023-06-30T13:42:49+09:00", "publisher": "HL7 Korea", "contact": [ { "name": "HL7 Korea", "telecom": [ { "system": "url", "value": "http://www.hl7korea.or.kr/" }, { "system": "email", "value": "contact@healthall.co.kr" } ] }, { "name": "HealthAll Inc.", "telecom": [ { "system": "email", "value": "contact@healthall.co.kr", "use": "work" } ] } ], "description": "KR Core의 예방 접종 정보에 적용되는 Immunization 구조.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "KR", "display": "Korea, Republic of" } ] } ], "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "cda", "uri": "http://hl7.org/v3/cda", "name": "CDA (R2)" } ], "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "snapshot": { "element": [ { "id": "Immunization", "path": "Immunization", "short": "KR Core Immunization Profile", "definition": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.", "min": 0, "max": "*", "base": { "path": "Immunization", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "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", "expression": "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()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "v2", "map": "VXU_V04" }, { "identity": "rim", "map": "SubstanceAdministration" } ] }, { "id": "Immunization.id", "path": "Immunization.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": true }, { "id": "Immunization.meta", "path": "Immunization.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Immunization.implicitRules", "path": "Immunization.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true }, { "id": "Immunization.language", "path": "Immunization.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } }, { "id": "Immunization.text", "path": "Immunization.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Immunization.contained", "path": "Immunization.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.extension", "path": "Immunization.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.modifierExtension", "path": "Immunization.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.identifier", "path": "Immunization.identifier", "short": "Business identifier", "definition": "A unique identifier assigned to this immunization record.", "min": 0, "max": "*", "base": { "path": "Immunization.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".id" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id" } ] }, { "id": "Immunization.status", "path": "Immunization.status", "short": "예방 접종 상태: completed | entered-in-error | not-done", "definition": "Indicates the current status of the immunization event.", "comment": "Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "base": { "path": "Immunization.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "example": [ { "label": "Value (Preferred)", "valueCode": "completed" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": true, "isModifierReason": "This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationStatus" } ], "strength": "required", "description": "A set of codes indicating the current status of an Immunization.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-status|4.0.1" }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "statusCode" } ] }, { "id": "Immunization.statusReason", "path": "Immunization.statusReason", "short": "Reason not done", "definition": "Indicates the reason the immunization event was not performed.", "comment": "This is generally only used for the status of \"not-done\". The reason for performing the immunization event is captured in reasonCode, not here.", "min": 0, "max": "1", "base": { "path": "Immunization.statusReason", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationStatusReason" } ], "strength": "example", "description": "The reason why a vaccine was not administered.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-status-reason" }, "mapping": [ { "identity": "workflow", "map": "Event.statusReason" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" } ] }, { "id": "Immunization.vaccineCode", "path": "Immunization.vaccineCode", "short": "예방접종 식별 코드", "definition": "Vaccine that was administered or was to be administered.", "min": 1, "max": "1", "base": { "path": "Immunization.vaccineCode", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VaccineCode" } ], "strength": "example", "description": "The code for vaccine product administered.", "valueSet": "http://hl7.org/fhir/ValueSet/vaccine-code" }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "v2", "map": "RXA-5" }, { "identity": "rim", "map": ".code" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code" } ] }, { "id": "Immunization.vaccineCode.id", "path": "Immunization.vaccineCode.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.vaccineCode.extension", "path": "Immunization.vaccineCode.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.vaccineCode.coding", "path": "Immunization.vaccineCode.coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 1, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id": "Immunization.vaccineCode.coding:VcntType", "path": "Immunization.vaccineCode.coding", "sliceName": "VcntType", "short": "예방접종 분류", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 1, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": { "strength": "required", "valueSet": "http://www.hl7korea.or.kr/fhir/krcore/ValueSet/krcore-vcnt-type-codes" }, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id": "Immunization.vaccineCode.coding:VcntType.id", "path": "Immunization.vaccineCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.vaccineCode.coding:VcntType.extension", "path": "Immunization.vaccineCode.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.vaccineCode.coding:VcntType.system", "path": "Immunization.vaccineCode.coding.system", "short": "예방접종 분류 코드체계", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Immunization.vaccineCode.coding:VcntType.version", "path": "Immunization.vaccineCode.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Immunization.vaccineCode.coding:VcntType.code", "path": "Immunization.vaccineCode.coding.code", "short": "예방접종 분류 코드", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Immunization.vaccineCode.coding:VcntType.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.vaccineCode.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id": "Immunization.vaccineCode.coding:VcntType.userSelected", "path": "Immunization.vaccineCode.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ] }, { "id": "Immunization.vaccineCode.coding:KDCode", "path": "Immunization.vaccineCode.coding", "sliceName": "KDCode", "short": "식품의약품안전처 의약품표준 코드 정보", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "strength": "required", "valueSet": "http://www.hl7korea.or.kr/fhir/krcore/ValueSet/krcore-korea-drug-codes" }, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id": "Immunization.vaccineCode.coding:KDCode.id", "path": "Immunization.vaccineCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.vaccineCode.coding:KDCode.extension", "path": "Immunization.vaccineCode.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.vaccineCode.coding:KDCode.system", "path": "Immunization.vaccineCode.coding.system", "short": "식품의약품안전처 의약품표준 코드체계", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Immunization.vaccineCode.coding:KDCode.version", "path": "Immunization.vaccineCode.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Immunization.vaccineCode.coding:KDCode.code", "path": "Immunization.vaccineCode.coding.code", "short": "식품의약품안전처 의약품표준 코드", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Immunization.vaccineCode.coding:KDCode.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.vaccineCode.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id": "Immunization.vaccineCode.coding:KDCode.userSelected", "path": "Immunization.vaccineCode.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ] }, { "id": "Immunization.vaccineCode.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.vaccineCode.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id": "Immunization.patient", "path": "Immunization.patient", "short": "예방 접종 대상", "definition": "The patient who either received or did not receive the immunization.", "min": 1, "max": "1", "base": { "path": "Immunization.patient", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".partipication[ttypeCode=].role" }, { "identity": "w5", "map": "FiveWs.subject" } ] }, { "id": "Immunization.encounter", "path": "Immunization.encounter", "short": "Encounter immunization was part of", "definition": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.", "min": 0, "max": "1", "base": { "path": "Immunization.encounter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "PV1-19" }, { "identity": "rim", "map": "component->EncounterEvent" } ] }, { "id": "Immunization.occurrence[x]", "path": "Immunization.occurrence[x]", "short": "예방 접종 일시", "definition": "Date vaccine administered or was to be administered.", "comment": "When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.", "min": 1, "max": "1", "base": { "path": "Immunization.occurrence[x]", "min": 1, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "v2", "map": "RXA-3" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value" } ] }, { "id": "Immunization.recorded", "path": "Immunization.recorded", "short": "When the immunization was first captured in the subject's record", "definition": "The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.", "min": 0, "max": "1", "base": { "path": "Immunization.recorded", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" } ] }, { "id": "Immunization.primarySource", "path": "Immunization.primarySource", "short": "Indicates context the data was recorded in", "definition": "An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.", "comment": "Reflects the “reliability” of the content.", "min": 0, "max": "1", "base": { "path": "Immunization.primarySource", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.source" }, { "identity": "v2", "map": "RXA-9" }, { "identity": "rim", "map": "immunization.uncertaintycode (if primary source=false, uncertainty=U)" } ] }, { "id": "Immunization.reportOrigin", "path": "Immunization.reportOrigin", "short": "Indicates the source of a secondarily reported record", "definition": "The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.", "comment": "Should not be populated if primarySource = True, not required even if primarySource = False.", "min": 0, "max": "1", "base": { "path": "Immunization.reportOrigin", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationReportOrigin" } ], "strength": "example", "description": "The source of the data for a record which is not from a primary source.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-origin" }, "mapping": [ { "identity": "w5", "map": "FiveWs.source" }, { "identity": "v2", "map": "RXA-9" }, { "identity": "rim", "map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)" } ] }, { "id": "Immunization.location", "path": "Immunization.location", "short": "Where immunization occurred", "definition": "The service delivery location where the vaccine administration occurred.", "min": 0, "max": "1", "base": { "path": "Immunization.location", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.location" }, { "identity": "w5", "map": "FiveWs.where[x]" }, { "identity": "v2", "map": "RXA-27 (or RXA-11, deprecated as of v2.7)" }, { "identity": "rim", "map": ".participation[typeCode=LOC].COCT_MT240000UV" } ] }, { "id": "Immunization.manufacturer", "path": "Immunization.manufacturer", "short": "Vaccine manufacturer", "definition": "Name of vaccine manufacturer.", "min": 0, "max": "1", "base": { "path": "Immunization.manufacturer", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "RXA-17" }, { "identity": "rim", "map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name" } ] }, { "id": "Immunization.lotNumber", "path": "Immunization.lotNumber", "short": "Vaccine lot number", "definition": "Lot number of the vaccine product.", "min": 0, "max": "1", "base": { "path": "Immunization.lotNumber", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "RXA-15" }, { "identity": "rim", "map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText" } ] }, { "id": "Immunization.expirationDate", "path": "Immunization.expirationDate", "short": "Vaccine expiration date", "definition": "Date vaccine batch expires.", "min": 0, "max": "1", "base": { "path": "Immunization.expirationDate", "min": 0, "max": "1" }, "type": [ { "code": "date" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "RXA-16" }, { "identity": "rim", "map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime" } ] }, { "id": "Immunization.site", "path": "Immunization.site", "short": "Body site vaccine was administered", "definition": "Body site where vaccine was administered.", "min": 0, "max": "1", "base": { "path": "Immunization.site", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationSite" } ], "strength": "example", "description": "The site at which the vaccine was administered.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-site" }, "mapping": [ { "identity": "v2", "map": "RXR-2" }, { "identity": "rim", "map": "observation.targetSiteCode" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code" } ] }, { "id": "Immunization.route", "path": "Immunization.route", "short": "How vaccine entered body", "definition": "The path by which the vaccine product is taken into the body.", "min": 0, "max": "1", "base": { "path": "Immunization.route", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationRoute" } ], "strength": "example", "description": "The route by which the vaccine was administered.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-route" }, "mapping": [ { "identity": "v2", "map": "RXR-1" }, { "identity": "rim", "map": ".routeCode" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code" } ] }, { "id": "Immunization.doseQuantity", "path": "Immunization.doseQuantity", "short": "Amount of vaccine administered", "definition": "The quantity of vaccine product that was administered.", "min": 0, "max": "1", "base": { "path": "Immunization.doseQuantity", "min": 0, "max": "1" }, "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "RXA-6 / RXA-7" }, { "identity": "rim", "map": ".doseQuantity" } ] }, { "id": "Immunization.performer", "path": "Immunization.performer", "short": "Who performed event", "definition": "Indicates who performed the immunization event.", "min": 0, "max": "*", "base": { "path": "Immunization.performer", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer" }, { "identity": "v2", "map": "ORC-12 / RXA-10" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" } ] }, { "id": "Immunization.performer.id", "path": "Immunization.performer.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.performer.extension", "path": "Immunization.performer.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.performer.modifierExtension", "path": "Immunization.performer.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.function", "path": "Immunization.performer.function", "short": "What type of performance was done", "definition": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).", "min": 0, "max": "1", "base": { "path": "Immunization.performer.function", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationFunction" } ], "strength": "extensible", "description": "The role a practitioner or organization plays in the immunization event.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-function" }, "mapping": [ { "identity": "workflow", "map": "Event.performer.function" }, { "identity": "rim", "map": ".participation.functionCode" } ] }, { "id": "Immunization.performer.actor", "path": "Immunization.performer.actor", "short": "Individual or organization who was performing", "definition": "The practitioner or organization who performed the action.", "comment": "When the individual practitioner who performed the action is known, it is best to send.", "min": 1, "max": "1", "base": { "path": "Immunization.performer.actor", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "rim", "map": ".player" } ] }, { "id": "Immunization.note", "path": "Immunization.note", "short": "Additional immunization notes", "definition": "Extra information about the immunization that is not conveyed by the other attributes.", "min": 0, "max": "*", "base": { "path": "Immunization.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.note" }, { "identity": "v2", "map": "OBX-5 : OBX-3 = 48767-8" }, { "identity": "rim", "map": "note" } ] }, { "id": "Immunization.reasonCode", "path": "Immunization.reasonCode", "short": "Why immunization occurred", "definition": "Reasons why the vaccine was administered.", "min": 0, "max": "*", "base": { "path": "Immunization.reasonCode", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationReason" } ], "strength": "example", "description": "The reason why a vaccine was administered.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-reason" }, "mapping": [ { "identity": "workflow", "map": "Event.reasonCode" }, { "identity": "rim", "map": "[actionNegationInd=false].reasonCode" } ] }, { "id": "Immunization.reasonReference", "path": "Immunization.reasonReference", "short": "Why immunization occurred", "definition": "Condition, Observation or DiagnosticReport that supports why the immunization was administered.", "min": 0, "max": "*", "base": { "path": "Immunization.reasonReference", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.reasonReference" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.isSubpotent", "path": "Immunization.isSubpotent", "short": "Dose potency", "definition": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.", "comment": "Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.", "min": 0, "max": "1", "base": { "path": "Immunization.isSubpotent", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "meaningWhenMissing": "By default, a dose should be considered to be potent.", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXA-20 = PA (partial administration)" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.subpotentReason", "path": "Immunization.subpotentReason", "short": "Reason for being subpotent", "definition": "Reason why a dose is considered to be subpotent.", "min": 0, "max": "*", "base": { "path": "Immunization.subpotentReason", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubpotentReason" } ], "strength": "example", "description": "The reason why a dose is considered to be subpotent.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-subpotent-reason" }, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.education", "path": "Immunization.education", "short": "Educational material presented to patient", "definition": "Educational material presented to the patient (or guardian) at the time of vaccine administration.", "min": 0, "max": "*", "base": { "path": "Immunization.education", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "imm-1", "severity": "error", "human": "One of documentType or reference SHALL be present", "expression": "documentType.exists() or reference.exists()", "xpath": "exists(f:documentType) or exists(f:reference)", "source": "http://hl7.org/fhir/StructureDefinition/Immunization" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.education.id", "path": "Immunization.education.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.education.extension", "path": "Immunization.education.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.education.modifierExtension", "path": "Immunization.education.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.education.documentType", "path": "Immunization.education.documentType", "short": "Educational material document identifier", "definition": "Identifier of the material presented to the patient.", "min": 0, "max": "1", "base": { "path": "Immunization.education.documentType", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 = 69764-9" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.education.reference", "path": "Immunization.education.reference", "short": "Educational material reference pointer", "definition": "Reference pointer to the educational material given to the patient if the information was on line.", "min": 0, "max": "1", "base": { "path": "Immunization.education.reference", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.education.publicationDate", "path": "Immunization.education.publicationDate", "short": "Educational material publication date", "definition": "Date the educational material was published.", "min": 0, "max": "1", "base": { "path": "Immunization.education.publicationDate", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 = 29768-9" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.education.presentationDate", "path": "Immunization.education.presentationDate", "short": "Educational material presentation date", "definition": "Date the educational material was given to the patient.", "min": 0, "max": "1", "base": { "path": "Immunization.education.presentationDate", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 = 29769-7" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.programEligibility", "path": "Immunization.programEligibility", "short": "Patient eligibility for a vaccination program", "definition": "Indicates a patient's eligibility for a funding program.", "min": 0, "max": "*", "base": { "path": "Immunization.programEligibility", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProgramEligibility" } ], "strength": "example", "description": "The patient's eligibility for a vaccation program.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-program-eligibility" }, "mapping": [ { "identity": "v2", "map": "OBX-5 : OBX-3 = 64994-7" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.fundingSource", "path": "Immunization.fundingSource", "short": "Funding source for the vaccine", "definition": "Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).", "min": 0, "max": "1", "base": { "path": "Immunization.fundingSource", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FundingSource" } ], "strength": "example", "description": "The source of funding used to purchase the vaccine administered.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-funding-source" }, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.reaction", "path": "Immunization.reaction", "short": "Details of a reaction that follows immunization", "definition": "Categorical data indicating that an adverse event is associated in time to an immunization.", "comment": "A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.", "min": 0, "max": "*", "base": { "path": "Immunization.reaction", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-3" }, { "identity": "rim", "map": "Observation[classCode=obs].code" } ] }, { "id": "Immunization.reaction.id", "path": "Immunization.reaction.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.reaction.extension", "path": "Immunization.reaction.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.reaction.modifierExtension", "path": "Immunization.reaction.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.reaction.date", "path": "Immunization.reaction.date", "short": "When reaction started", "definition": "Date of reaction to the immunization.", "min": 0, "max": "1", "base": { "path": "Immunization.reaction.date", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)" }, { "identity": "rim", "map": ".effectiveTime" } ] }, { "id": "Immunization.reaction.detail", "path": "Immunization.reaction.detail", "short": "Additional information on reaction", "definition": "Details of the reaction.", "min": 0, "max": "1", "base": { "path": "Immunization.reaction.detail", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-5" }, { "identity": "rim", "map": ".value" } ] }, { "id": "Immunization.reaction.reported", "path": "Immunization.reaction.reported", "short": "Indicates self-reported reaction", "definition": "Self-reported indicator.", "min": 0, "max": "1", "base": { "path": "Immunization.reaction.reported", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "(HL7 v2 doesn't seem to provide for this)" }, { "identity": "rim", "map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)" } ] }, { "id": "Immunization.protocolApplied", "path": "Immunization.protocolApplied", "short": "예방 접종 프로토콜", "definition": "The protocol (set of recommendations) being followed by the provider who administered the dose.", "min": 0, "max": "*", "base": { "path": "Immunization.protocolApplied", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.id", "path": "Immunization.protocolApplied.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.protocolApplied.extension", "path": "Immunization.protocolApplied.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.protocolApplied.modifierExtension", "path": "Immunization.protocolApplied.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.series", "path": "Immunization.protocolApplied.series", "short": "Name of vaccine series", "definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.", "min": 0, "max": "1", "base": { "path": "Immunization.protocolApplied.series", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.authority", "path": "Immunization.protocolApplied.authority", "short": "Who is responsible for publishing the recommendations", "definition": "Indicates the authority who published the protocol (e.g. ACIP) that is being followed.", "min": 0, "max": "1", "base": { "path": "Immunization.protocolApplied.authority", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.targetDisease", "path": "Immunization.protocolApplied.targetDisease", "short": "Vaccine preventatable disease being targetted", "definition": "The vaccine preventable disease the dose is being administered against.", "min": 0, "max": "*", "base": { "path": "Immunization.protocolApplied.targetDisease", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TargetDisease" } ], "strength": "example", "description": "The vaccine preventable disease the dose is being administered for.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-target-disease" }, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.doseNumber[x]", "path": "Immunization.protocolApplied.doseNumber[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" }, "short": "Dose number within series", "definition": "Nominal position in a series.", "comment": "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).", "min": 1, "max": "1", "base": { "path": "Immunization.protocolApplied.doseNumber[x]", "min": 1, "max": "1" }, "type": [ { "code": "positiveInt" }, { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt", "path": "Immunization.protocolApplied.doseNumber[x]", "sliceName": "doseNumberPositiveInt", "short": "예방 접종 차수", "definition": "Nominal position in a series.", "comment": "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).", "min": 0, "max": "1", "base": { "path": "Immunization.protocolApplied.doseNumber[x]", "min": 1, "max": "1" }, "type": [ { "code": "positiveInt" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.seriesDoses[x]", "path": "Immunization.protocolApplied.seriesDoses[x]", "short": "Recommended number of doses for immunity", "definition": "The recommended number of doses to achieve immunity.", "comment": "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).", "min": 0, "max": "1", "base": { "path": "Immunization.protocolApplied.seriesDoses[x]", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" }, { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "id": "Immunization", "path": "Immunization", "short": "KR Core Immunization Profile" }, { "id": "Immunization.status", "path": "Immunization.status", "short": "예방 접종 상태: completed | entered-in-error | not-done", "example": [ { "label": "Value (Preferred)", "valueCode": "completed" } ], "mustSupport": true }, { "id": "Immunization.vaccineCode", "path": "Immunization.vaccineCode", "short": "예방접종 식별 코드", "mustSupport": true }, { "id": "Immunization.vaccineCode.coding", "path": "Immunization.vaccineCode.coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "min": 1 }, { "id": "Immunization.vaccineCode.coding:VcntType", "path": "Immunization.vaccineCode.coding", "sliceName": "VcntType", "short": "예방접종 분류", "min": 1, "max": "*", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://www.hl7korea.or.kr/fhir/krcore/ValueSet/krcore-vcnt-type-codes" } }, { "id": "Immunization.vaccineCode.coding:VcntType.system", "path": "Immunization.vaccineCode.coding.system", "short": "예방접종 분류 코드체계", "min": 1, "fixedUri": "http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types", "mustSupport": true }, { "id": "Immunization.vaccineCode.coding:VcntType.code", "path": "Immunization.vaccineCode.coding.code", "short": "예방접종 분류 코드", "min": 1, "mustSupport": true }, { "id": "Immunization.vaccineCode.coding:KDCode", "path": "Immunization.vaccineCode.coding", "sliceName": "KDCode", "short": "식품의약품안전처 의약품표준 코드 정보", "min": 0, "max": "*", "binding": { "strength": "required", "valueSet": "http://www.hl7korea.or.kr/fhir/krcore/ValueSet/krcore-korea-drug-codes" } }, { "id": "Immunization.vaccineCode.coding:KDCode.system", "path": "Immunization.vaccineCode.coding.system", "short": "식품의약품안전처 의약품표준 코드체계", "min": 1, "fixedUri": "http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode" }, { "id": "Immunization.vaccineCode.coding:KDCode.code", "path": "Immunization.vaccineCode.coding.code", "short": "식품의약품안전처 의약품표준 코드", "min": 1 }, { "id": "Immunization.patient", "path": "Immunization.patient", "short": "예방 접종 대상", "type": [ { "code": "Reference", "targetProfile": [ "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" ] } ] }, { "id": "Immunization.occurrence[x]", "path": "Immunization.occurrence[x]", "short": "예방 접종 일시", "type": [ { "code": "dateTime" } ], "mustSupport": true }, { "id": "Immunization.protocolApplied", "path": "Immunization.protocolApplied", "short": "예방 접종 프로토콜" }, { "id": "Immunization.protocolApplied.doseNumberPositiveInt", "path": "Immunization.protocolApplied.doseNumberPositiveInt", "short": "예방 접종 차수", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ] } ] } }
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | Immunization | KR Core Immunization Profile | |
status | S | 1..1 | code | 예방 접종 상태: completed | entered-in-error | not-done Example Value (Preferred): completed |
vaccineCode | S | 1..1 | CodeableConcept | 예방접종 식별 코드 |
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | |
coding:VcntType | S | 1..* | Coding | 예방접종 분류 Binding: KR Core Vaccination Type Codes (required) |
system | S | 1..1 | uri | 예방접종 분류 코드체계 Fixed Value: http://www.hl7korea.or.kr/fhir/krcore/CodeSystem/krcore-vcnt-types |
code | S | 1..1 | code | 예방접종 분류 코드 |
coding:KDCode | 0..* | Coding | 식품의약품안전처 의약품표준 코드 정보 Binding: KR Core Korea Drug Codes (required) | |
system | 1..1 | uri | 식품의약품안전처 의약품표준 코드체계 Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode | |
code | 1..1 | code | 식품의약품안전처 의약품표준 코드 | |
patient | 1..1 | Reference(KR Core Patient Profile) | 예방 접종 대상 | |
occurrence[x] | S | 1..1 | dateTime | 예방 접종 일시 |
protocolApplied | 0..* | BackboneElement | 예방 접종 프로토콜 | |
doseNumberPositiveInt | 0..1 | positiveInt | 예방 접종 차수 | |
Documentation for this format |