Vacunas

Aquí se presentan todos los recursos que se utilizaron para mapear la información de las Vacunas.

  1. Definición de estructura para los datos de las Vacunas, aqui se definen principalmente los campos utilizados del recurso Immunization de HL7 FHIR. También puedes encontrar el recurso en https://simplifier.net/test-api-minsal/immunizationvacunasv3.

status
code
display
text
patientReference(Patient_apimin_v3)
date
locationReference(Location_apimin_v3)
lotNumber
doseQuantity
text
detailReference(Observation_apimin_v3)
series

  1. Definición de estructura para los datos del paciente. También puedes encontrar el recurso en https://simplifier.net/test-api-minsal/patientapiminv3.

system
valueS
birthDateS

  1. Definición de estructura para los datos del paciente. También puedes encontrar el recurso en https://simplifier.net/test-api-minsal/observationapiminv3.

system
code
text
valueQuantityQuantity
valueStringstring

  1. Definición de estructura para los datos del lugar el cual pertenece a la organización que relizó la vacuna. También puedes encontrar el recurso en https://simplifier.net/test-api-minsal/locationapiminv3.

system
value
name
text

Parámetros de Búsqueda Vacunas

Nombre Tipo Descripción Expresión Ejemplo
patient token Utilizado como el rut del paciente sin dígito verificador Immunization.patient patient.identifier=1111111
date date Fecha de la vacuna en formato YYYY-MM-DD Immunization.date date=2018-10-12 date=ge2018-10-12 date=lt2018-10-12
vaccine-code token Tipo de programa de Vacuna Immunization.vaccineCode vaccine-code=INTERNACIONAL

Prefijos implementados para búsquedas por fecha

Expresión Definición Ejemplo Significado
ge Mayor o Igual que ge2018-10-12 Resultados con fecha posterior o igual a 2018-10-12
lt Menor que lt2018-10-12 Resultados con fecha anterior a 2018-10-12

Referencia: Documentación completa en FHIR

Ejemplos de búsqueda

  • Búsqueda solo por rut
    GET [base]/Immunization?patient.identifer=23504868
    
  • Búsqueda por rut y rango de fechas
    GET [base]/Immunization?patient.identifer=23504868&date=ge2016-01-03&date=lt2018-01-03
    
  • Búsqueda por rut y tipo de vacunas
    GET [base]/Immunization?patient.identifer=23504868&vaccine-code=INTERNACIONAL
    
  • Búsqueda por rut, rango de fechas y tipo
    GET [base]/Immunization?patient.identifer=23504868&vaccine-code=INTERNACIONAL&date=ge2016-01-03&date=lt2018-01-03
    

Ejemplo de response

{
    "resourceType": "Bundle",
    "id": "819c58ce-44ff-475a-9a76-c9f0c59b35a2",
    "meta": {
        "lastUpdated": "2019-01-15T09:43:35.354-03:00"
    },
    "type": "searchset",
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "http://192.168.60.24:8080/hospital-digital-fhir-server-3.0/fhir/Immunization?patient.identifer=23504868&vaccine-code=INTERNACIONAL"
        }
    ],
    "entry": [
        {
            "fullUrl": "http://192.168.60.24:8080/hospital-digital-fhir-server-3.0/fhir/Immunization/v242254420",
            "resource": {
                "resourceType": "Immunization",
                "id": "v242254420",
                "contained": [
                    {
                        "resourceType": "Patient",
                        "id": "p1",
                        "identifier": [
                            {
                                "system": "https://www.srcei.cl/RUT",
                                "value": "23504868"
                            }
                        ]
                    },
                    {
                        "resourceType": "Location",
                        "id": "l1",
                        "identifier": [
                            {
                                "system": "http://www.deis.cl",
                                "value": "9999"
                            }
                        ],
                        "name": "Clínica Alemana"
                    },
                    {
                        "resourceType": "Observation",
                        "id": "ob1",
                        "status": "registered",
                        "code": {
                            "text": "indeterminado"
                        },
                        "valueString": "SinReaccion"
                    }
                ],
                "status": "completed",
                "vaccineCode": {
                    "coding": [
                        {
                            "system": "https://vacunas.minsal.cl",
                            "display": "VACUNA FIEBRE AMARILLA"
                        }
                    ]
                },
                "patient": {
                    "reference": "#p1"
                },
                "date": "2016-01-05T00:00:00-03:00",
                "location": {
                    "reference": "#l1"
                },
                "lotNumber": "L5058-3",
                "doseQuantity": {
                    "code": "Única (0,5ml)"
                },
                "reaction": [
                    {
                        "detail": {
                            "reference": "#ob1"
                        }
                    }
                ],
                "vaccinationProtocol": [
                    {
                        "series": "INTERNACIONAL"
                    }
                ]
            }
        },
        {
            "fullUrl": "http://192.168.60.24:8080/hospital-digital-fhir-server-3.0/fhir/Immunization/v242322222",
            "resource": {
                "resourceType": "Immunization",
                "id": "v242322222",
                "contained": [
                    {
                        "resourceType": "Patient",
                        "id": "p1",
                        "identifier": [
                            {
                                "system": "https://www.srcei.cl/RUT",
                                "value": "23504868"
                            }
                        ]
                    },
                    {
                        "resourceType": "Location",
                        "id": "l1",
                        "identifier": [
                            {
                                "system": "http://www.deis.cl",
                                "value": "9999"
                            }
                        ],
                        "name": "Clínica Alemana"
                    },
                    {
                        "resourceType": "Observation",
                        "id": "ob1",
                        "status": "registered",
                        "code": {
                            "text": "indeterminado"
                        },
                        "valueString": "SinReaccion"
                    }
                ],
                "status": "completed",
                "vaccineCode": {
                    "coding": [
                        {
                            "system": "https://vacunas.minsal.cl",
                            "display": "VACUNA FIEBRE AMARILLA"
                        }
                    ]
                },
                "patient": {
                    "reference": "#p1"
                },
                "date": "2016-01-05T00:00:00-03:00",
                "location": {
                    "reference": "#l1"
                },
                "lotNumber": "L5058-3",
                "doseQuantity": {
                    "code": "Única (0,5ml)"
                },
                "reaction": [
                    {
                        "detail": {
                            "reference": "#ob1"
                        }
                    }
                ],
                "vaccinationProtocol": [
                    {
                        "series": "INTERNACIONAL"
                    }
                ]
            }
        }
    ]
}

Dicccionario de Datos

Diccionario de Immunization

Immunization
DefinitionDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
Cardinality0...*
Invariants
  • dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative
    contained.text.empty()
  • dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
    contained.where(('#'+id in %resource.descendants().reference).not()).empty()
  • imm-2:If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    (notGiven = true) or explanation.reasonNotGiven.empty()
  • imm-1:If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
Mappings
  • rim:Entity. Role, or Act
  • v2:VXU_V04
  • rim:SubstanceAdministration
  • w5:clinical.medication
Immunization.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
SummaryTrue
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:N/A
Immunization.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

languages (extensible)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.text
DefinitionA human-readable narrative that contains a summary of the resource, and may 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, 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 in formation is added later.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:N/A
  • rim:Act.text?
Immunization.contained
DefinitionThese 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.
Cardinality0...*
TypeResource
Aliasinline 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.

Mappings
  • rim:Entity. Role, or Act
  • rim:N/A
Immunization.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.modifierExtension
DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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.
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.identifier
DefinitionA unique identifier assigned to this immunization record.
Cardinality0...*
TypeIdentifier
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd:Identifier
  • workflow:Event.identifier
  • rim:.id
  • cda:ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
  • w5:id
Immunization.status
DefinitionIndicates the current status of the vaccination event.
Cardinality1...1
Typecode
Binding

A set of codes indicating the current status of an Immunization

immunization-status (required)
ModifierTrue
SummaryTrue
Comments

Will generally be set to show that the immunization has been completed.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • workflow:Event.status
  • rim:statusCode
  • w5:status
  • api-minsal:tipo_fuente
Immunization.notGiven
DefinitionIndicates if the vaccination was or was not given.
Cardinality1...1
Typeboolean
ModifierTrue
SummaryTrue
Comments

This element is labeled as a modifier because it indicates that an immunization didn't happen.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • workflow:Event.notDone
  • rim:[actionNegationInd=true].reasonCode
  • w5:status
Immunization.vaccineCode
DefinitionVaccine that was administered or was to be administered.
Cardinality1...1
TypeCodeableConcept
Binding

The code for vaccine product administered

vaccine-code (example)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow:Event.code
  • v2:RXA-5
  • rim:.code
  • cda:ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
  • w5:what
Immunization.vaccineCode.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.vaccineCode.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.vaccineCode.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Immunization.vaccineCode.coding.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.vaccineCode.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.vaccineCode.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
SummaryTrue
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 de-reference to some definition that establish the system clearly and unambiguously.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Immunization.vaccineCode.coding.version
DefinitionThe 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.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Immunization.vaccineCode.coding.code
DefinitionCódigo que representa un valor dentro de un sistema.
Cardinality0...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • api-minsal:TIPO
Immunization.vaccineCode.coding.display
DefinitionTexto explicativo del nombre de la vacuna.
Cardinality0...1
Typestring
SummaryTrue
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 may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Immunization.vaccineCode.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim: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 ]
Immunization.vaccineCode.text
DefinitionA 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.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.9. But note many systems use C*E.2 for this
  • rim:./originalText[mediaType/code="text/plain"]/data
  • orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
  • api-minsal:NOMBRE_VACUNA
Immunization.patient
DefinitionPaciente al cual se le aplicó la vacuna.
Cardinality1...1
TypeReference(Patient_apimin_v3)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow:Event.subject
  • v2:PID-3
  • rim:.partipication[ttypeCode=].role
  • w5:who.focus
Immunization.encounter
DefinitionThe visit or admission or other contact between patient and health care provider the immunization was performed as part of.
Cardinality0...1
TypeReference(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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow:Event.context
  • v2:PV1-19
  • rim:component->EncounterEvent
  • w5:context
Immunization.date
DefinitionFecha en la que se administro la vacuna.
Cardinality0...1
TypedateTime
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.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • workflow:Event.occurrence.occurrenceDateTime
  • v2:RXA-3
  • rim:.effectiveTime
  • cda:ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
  • w5:when.init
  • api-minsal:FECHA_INMUNIZACION
Immunization.primarySource
DefinitionAn 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.
Cardinality1...1
Typeboolean
Comments

Reflects the “reliability” of the content.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:RXA-9
  • rim:immunization.uncertaintycode (if primary source=false, uncertainty=U)
  • w5:who.source
Immunization.reportOrigin
DefinitionThe source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
Cardinality0...1
TypeCodeableConcept
Binding

The source of the data for a record which is not from a primary source.

immunization-origin (example)
Comments

Should not be populated if primarySource = True, will not be required even if primarySource = False.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:RXA-9
  • rim:.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)
  • w5:who.source
Immunization.location
DefinitionThe service delivery location where the vaccine administration occurred.
Cardinality0...1
TypeReference(Location_apimin_v3)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2:RXA-27 (or RXA-11, deprecated as of v2.7)
  • rim:.participation[typeCode=LOC].COCT_MT240000UV
  • w5:where
Immunization.manufacturer
DefinitionName of vaccine manufacturer.
Cardinality0...1
TypeReference(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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2:RXA-17
  • rim:.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
  • cda:ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
Immunization.lotNumber
DefinitionNúmero del lote de la vacuna.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:RXA-15
  • rim:.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
  • cda:ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
  • api-minsal:LOTE
Immunization.expirationDate
DefinitionDate vaccine batch expires.
Cardinality0...1
Typedate
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:RXA-16
  • rim:.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
Immunization.site
DefinitionBody site where vaccine was administered.
Cardinality0...1
TypeCodeableConcept
Binding

The site at which the vaccine was administered

immunization-site (example)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:RXR-2
  • rim:observation.targetSiteCode
  • cda:ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
Immunization.route
DefinitionThe path by which the vaccine product is taken into the body.
Cardinality0...1
TypeCodeableConcept
Binding

The route by which the vaccine was administered

immunization-route (example)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:RXR-1
  • rim:.routeCode
  • cda:ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
Immunization.doseQuantity
DefinitionLa cantidad de la vacuna que se administro.
Cardinality0...1
TypeSimpleQuantity
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • qty-3:If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • sqty-1:The comparator is not used on a SimpleQuantity
    comparator.empty()
Mappings
  • rim:n/a
  • v2:SN (see also Range) or CQ
  • rim:PQ, IVL<PQ>, MO, CO, depending on the values
  • v2:RXA-6 / RXA-7.1
  • rim:.doseQuantity
  • api-minsal:DOSIS
Immunization.practitioner
DefinitionIndicates who or what performed the event.
Cardinality0...*
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • workflow:Event.performer
  • v2:ORC-12 / RXA-10
  • rim:.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
Immunization.practitioner.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.practitioner.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.practitioner.modifierExtension
DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.practitioner.role
DefinitionDescribes the type of performance (e.g. ordering provider, administering provider, etc.).
Cardinality0...1
TypeCodeableConcept
Binding

The role a practitioner plays in the immunization event

immunization-role (extensible)
SummaryTrue
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow:Event.performer.role
  • rim:.participation.functionCode
Immunization.practitioner.actor
DefinitionThe device, practitioner, etc. who performed the action.
Cardinality1...1
TypeReference(Practitioner)
SummaryTrue
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow:Event.performer.actor
  • rim:.player
  • w5:who.actor
Immunization.note
DefinitionExtra information about the immunization that is not conveyed by the other attributes.
Cardinality0...*
TypeAnnotation
SummaryTrue
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:N/A
  • rim:Act
  • workflow:Event.note
  • rim:note
Immunization.explanation
DefinitionReasons why a vaccine was or was not administered.
Cardinality0...1
TypeBackboneElement
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.explanation.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.explanation.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.explanation.modifierExtension
DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.explanation.reason
DefinitionRazón o Razones del porque se administro la vacuna.
Cardinality0...*
TypeCodeableConcept
Binding

The reason why a vaccine was administered

immunization-reason (example)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow:Event.reasonCodeableConcept
  • rim:[actionNegationInd=false].reasonCode
Immunization.explanation.reason.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.explanation.reason.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.explanation.reason.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
SummaryTrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim:CV
  • orim:fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2:C*E.1-8, C*E.10-22
  • rim:union(., ./translation)
  • orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Immunization.explanation.reason.text
DefinitionRazón porque se eligio la vacuna.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.9. But note many systems use C*E.2 for this
  • rim:./originalText[mediaType/code="text/plain"]/data
  • orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
  • api-minsal:CRITERIO_ELEGIBILIDAD
Immunization.explanation.reasonNotGiven
DefinitionReason why a vaccine was not administered.
Cardinality0...*
TypeCodeableConcept
Binding

The reason why a vaccine was not administered

no-immunization-reason (example)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow:Event.notDoneReason
  • v2:RXA-18
  • rim:[actionNegationInd=true].reasonCode
Immunization.reaction
DefinitionCategorical data indicating that an adverse event is associated in time to an immunization.
Cardinality0...*
TypeBackboneElement
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:OBX-3
  • rim:Observation[classCode=obs].code
Immunization.reaction.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.reaction.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.reaction.modifierExtension
DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.reaction.date
DefinitionDate of reaction to the immunization.
Cardinality0...1
TypedateTime
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2: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)
  • rim:.effectiveTime
Immunization.reaction.detail
DefinitionDetails of the reaction.
Cardinality0...1
TypeReference(Observation_apimin_v3)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2:OBX-5
  • rim:.value
Immunization.reaction.reported
DefinitionSelf-reported indicator.
Cardinality0...1
Typeboolean
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:(no such concept seems to exist for allergy/adverse reaction in HL7 v2)
  • rim:.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
Immunization.vaccinationProtocol
DefinitionContains information about the protocol(s) under which the vaccine was administered.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:(HL7 v2 doesn't seem to provide for this)
  • rim:outboundRelationship[typeCode=INST].target[classCode=SBADM]
Immunization.vaccinationProtocol.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Immunization.vaccinationProtocol.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.vaccinationProtocol.modifierExtension
DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Immunization.vaccinationProtocol.doseSequence
DefinitionNominal position in a series.
Cardinality0...1
TypepositiveInt
Comments

32 bit number; for values larger than this, use decimal

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber
Immunization.vaccinationProtocol.description
DefinitionContains the description about the protocol under which the vaccine was administered.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
Immunization.vaccinationProtocol.authority
DefinitionIndicates the authority who published the protocol. E.g. ACIP.
Cardinality0...1
TypeReference(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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim:outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV
Immunization.vaccinationProtocol.series
DefinitionOne possible path to achieve presumed immunity against a disease - within the context of an authority.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:outboundRelationship[typeCode=INST].target[classCode=SBADM]
  • api-minsal:tipo
Immunization.vaccinationProtocol.seriesDoses
DefinitionThe recommended number of doses to achieve immunity.
Cardinality0...1
TypepositiveInt
Comments

32 bit number; for values larger than this, use decimal

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
Immunization.vaccinationProtocol.targetDisease
DefinitionThe targeted disease.
Cardinality1...*
TypeCodeableConcept
Binding

The disease target of the vaccination protocol

vaccination-protocol-dose-target (example)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:outboundRelationship.target[classCode=OBS].code
Immunization.vaccinationProtocol.doseStatus
DefinitionIndicates if the immunization event should "count" against the protocol.
Cardinality1...1
TypeCodeableConcept
Binding

The status of the vaccination protocol (i.e. should this count)

vaccination-protocol-dose-status (example)
Comments

May need to differentiate between status declarations by a provider vs. a CDS engine.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value
Immunization.vaccinationProtocol.doseStatusReason
DefinitionProvides an explanation as to why an immunization event should or should not count against the protocol.
Cardinality0...1
TypeCodeableConcept
Binding

The reason for the determining if a vaccination should count or why vaccination should not count.

vaccination-protocol-dose-status-reason (example)
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode