Narrativa gerada: StructureDefinition ImmunizationBRIPES Nome Bandeiras Card. Tipo Descrição e condicionalismos<img src="[binary]" alt="doco" style="background-color: inherit"/> Immunization 0..* Immunization Immunization event information #xD; Fatias para contained 0..1 Resource Contained, inline Resources Fatia: Não ordenado, Aberto por pattern:$this #xD; contained:practititonerContained 0..1 Practitioner Profissional #xD; meta 0..0 #xD; implicitRules 0..0 #xD; language 0..0 #xD; text 0..0 #xD; contained 0..0 #xD; Fatias para identifier 0..* Identifier An identifier for the person as this agent Fatia: Não ordenado, Aberto por pattern:$this #xD; identifier:cns 0..1 Identifier An identifier for the person as this agent #xD; use 0..0 #xD; type 0..0 #xD; system 1..1 uri The namespace for the identifier value Valor fixo: urn:oid:2.16.840.1.113883.13.236 #xD; value 1..1 string CNS do profissional #xD; period 0..0 #xD; assigner 0..0 #xD; identifier:cpf 0..1 Identifier An identifier for the person as this agent #xD; use 0..0 #xD; type 0..0 #xD; system 1..1 uri The namespace for the identifier value Valor fixo: urn:oid:2.16.840.1.113883.13.237 #xD; value 1..1 string CPF do profissional #xD; period 0..0 #xD; assigner 0..0 #xD; identifier:registroProfissional 0..1 Identifier An identifier for the person as this agent #xD; use 0..0 #xD; type 0..0 #xD; system 1..1 uri Namespace para registros de identificação civil Valor fixo: urn:oid:2.16.840.1.113883.13.243 #xD; value 1..1 string Número do registro #xD; period 0..0 #xD; assigner #xD; display 1..1 string Text alternative for the resource #xD; active 0..0 #xD; telecom 0..0 #xD; address 0..0 #xD; gender 0..0 #xD; birthDate 0..0 #xD; photo 0..0 #xD; qualification 0..0 #xD; communication 0..0 #xD; contained:organizationContained 0..1 Organization Organização #xD; meta 0..0 #xD; implicitRules 0..0 #xD; language 0..0 #xD; text 0..0 #xD; contained 0..0 #xD; Fatias para identifier 0..* Identifier Identifies this organization across multiple systems Fatia: Não ordenado, Aberto por pattern:$this #xD; identifier:cnes 0..1 Identifier Identifies this organization across multiple systems #xD; use 0..0 #xD; type 0..0 #xD; system 1..1 uri The namespace for the identifier value Valor fixo: urn:oid:2.16.840.1.113883.13.36 #xD; value 1..1 string CNES da organização #xD; period 0..0 #xD; assigner 0..0 #xD; active 0..0 #xD; type 0..0 #xD; telecom 0..0 #xD; address 0..0 #xD; partOf 0..0 #xD; contact 0..0 #xD; endpoint 0..0 #xD; Fatias para identifier 1..1 Identifier Business identifier Fatia: Não ordenado, Aberto por pattern:system #xD; identifier:localIdentifier 1..1 Identifier Identificador do registro no sistema de origem #xD; use 0..0 #xD; type 0..0 #xD; system 1..1 uri Identificador único do sistema de origem #xD; value 1..1 string Identificador do registro no sistema de origem #xD; period 0..0 #xD; assigner 0..0 #xD; statusReason 0..0 #xD; vaccineCode 1..1 CodeableConcept Vaccine product administered Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRImunobiologico (preferred) #xD; patient 1..1 Reference(Paciente) Who was immunized #xD; reference 1..1 string Literal reference, Relative, internal or absolute URL #xD; type 0..0 #xD; identifier 0..0 #xD; display 0..0 #xD; encounter 0..1 Reference(Contato Assistencial) Encounter immunization was part of #xD; occurrence[x] 1..1 dateTime Vaccine administration date #xD; recorded 0..0 #xD; reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRRegistroOrigem (preferred) #xD; location 0..0 #xD; manufacturer #xD; reference 0..0 #xD; type 0..0 #xD; site 0..1 CodeableConcept Body site vaccine was administered Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRLocalAplicacao (preferred) #xD; route 0..1 CodeableConcept How vaccine entered body Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRViaAdministracao (preferred) #xD; doseQuantity 0..0 #xD; Fatias para performer 0..* BackboneElement Who performed event Fatia: Não ordenado, Aberto por pattern:$this #xD; performer:practitioner 0..1 BackboneElement Who performed event #xD; function 0..0 #xD; actor 1..1 Reference(Practitioner) Individual or organization who was performing #xD; reference 0..1 string Profissional aplicador #xD; type 0..0 #xD; identifier 0..0 #xD; display 0..0 #xD; performer:practitionerContained 0..1 BackboneElement Who performed event #xD; function 0..0 #xD; actor 1..1 Reference(Practitioner) Individual or organization who was performing #xD; reference 1..1 string Literal reference, Relative, internal or absolute URL Valor fixo: #practitioner #xD; type 0..0 #xD; identifier 0..0 #xD; performer:organization 0..1 BackboneElement Who performed event #xD; function 0..0 #xD; actor 1..1 Reference(Organization) Individual or organization who was performing #xD; reference 0..1 string Organização aplicadora #xD; type 0..0 #xD; identifier 0..0 #xD; display 0..0 #xD; performer:organizationContained 0..1 BackboneElement Who performed event #xD; function 0..0 #xD; actor 1..1 Reference(Organization) Individual or organization who was performing #xD; reference 1..1 string Literal reference, Relative, internal or absolute URL Valor fixo: #organization #xD; type 0..0 #xD; identifier 0..0 #xD; reasonCode 0..0 #xD; reasonReference 0..0 #xD; isSubpotent 0..0 #xD; subpotentReason 0..0 #xD; education 0..0 #xD; programEligibility 0..0 #xD; fundingSource 0..0 #xD; reaction 0..0 #xD; protocolApplied 0..1 BackboneElement Protocol followed by the provider #xD; series 0..0 #xD; authority 0..0 #xD; targetDisease 0..0 #xD; doseNumber[x] 1..1 string Dose number within series Vínculo: https://terminologia.saude.gov.br/fhir/ValueSet/BRDose (preferred) #xD; seriesDoses[x] 0..0 #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentação para este formato
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.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
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='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
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.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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.
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
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
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.
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.
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.
Profissional aplicador, identificado pelo seu CPF, CNS ou Registro em Conselho Profissional.
Additional content defined by implementations
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
An identifier for the person as this agent
An identifier that applies to this person in this role.
Often, specific identities are assigned for the agent.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
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.
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Identifier.system is always case sensitive.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
Namespace para registros de identificação civil
Namespace para registros de identificação civil.
Literal reference, Relative, internal or absolute URL
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Type the reference refers to (e.g. "Patient")
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Aa resource (or, for logical models, the URI of the logical model).
Logical reference, when literal reference is not known
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Whether this practitioner's record is in active use
Whether this practitioner's record is in active use.
If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
Need to be able to mark a practitioner record as not to be used because it was created in error.
This resource is generally assumed to be active if no value is provided for the active element
The name(s) associated with the practitioner
The name(s) associated with the practitioner.
The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: 1. There is more than 1 name 2. Use = usual 3. Period is current to the date of the usage 4. Use = official 5. Other order as decided by internal business rules.
The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
./PreferredName (GivenNames, FamilyName, TitleCode)
A contact detail for the practitioner (that apply to all roles)
A contact detail for the practitioner, e.g. a telephone number or an email address.
Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Need to know how to reach a practitioner independent to any roles the practitioner may have.
Address(es) of the practitioner that are not role specific (typically home address)
Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
The gender of a person used for administrative purposes.
The date on which the practitioner was born
Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
./ImageURI (only supports the URI reference)
Certification, licenses, or training pertaining to the provision of care
The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
Extensions that cannot be ignored even if unrecognized
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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
An identifier for this qualification for the practitioner
An identifier that applies to this person's qualification in this role.
Often, specific identities are assigned for the qualification.
Coded representation of the qualification
Coded representation of the qualification.
Specific qualification the practitioner has to provide a service.
Period during which the qualification is valid
Period during which the qualification is valid.
Qualifications are often for a limited period of time, and can be revoked.
./Qualifications.StartDate and ./Qualifications.EndDate
Organization that regulates and issues the qualification
Organization that regulates and issues the qualification.
A language the practitioner can use in patient communication
A language the practitioner can use in patient communication.
The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Knowing which language a practitioner speaks can help in facilitating communication with patients.
Organização aplicadora, identificada pelo seu CNES.
Identifies this organization across multiple systems
Identifier for the organization that is used to identify the organization across multiple disparate systems.
Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Whether the organization's record is still in active use
Whether the organization's record is still in active use.
This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.
This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
The kind(s) of organization that this is.
Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality.
Need to be able to track the kind of organization that this is - different organization types have different uses.
A name associated with the organization.
If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Need to use the name as the label of the organization.
A list of alternate names that the organization is known as, or was known as in the past
A list of alternate names that the organization is known as, or was known as in the past.
There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful.
The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
The telecom of an organization can never be of use 'home'
Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
May need to keep track of the organization's addresses for contacting, billing or reporting requirements.
An address of an organization can never be of use 'home'
The organization of which this organization forms a part
The organization of which this organization forms a part.
Need to be able to track the hierarchy of organizations within an organization.
Contact for the organization for a certain purpose
Contact for the organization for a certain purpose.
Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
Need to keep track of assigned contact points within bigger organization.
Indicates a purpose for which the contact can be reached.
Need to distinguish between multiple contact persons.
The purpose for which you would contact a contact party.
Need to be able to track the person by name.
Contact details (telephone, email, etc.) for a contact
A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
People have (primary) ways to contact them in some way such as phone, email.
Visiting or postal addresses for the contact
Visiting or postal addresses for the contact.
May need to keep track of a contact party's address for contacting, billing or reporting requirements.
Technical endpoints providing access to services operated for the organization
Technical endpoints providing access to services operated for the organization.
Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
A unique identifier assigned to this immunization record.
Identificador do registro no sistema de origem
Identificador único do sistema de origem
URL ou OID da instância/sistema de origem - fornecido pela plataforma.
Indicates the current status of the immunization event.
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.
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
A set of codes indicating the current status of an Immunization.
Indicates the reason the immunization event was not performed.
This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.
The reason why a vaccine was not administered.
.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
Vaccine that was administered or was to be administered.
The patient who either received or did not receive the immunization.
The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
Date vaccine administered or was to be administered.
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.
When the immunization was first captured in the subject's record
The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
Indicates context the data was recorded in
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.
Reflects the “reliability” of the content.
immunization.uncertaintycode (if primary source=false, uncertainty=U)
Indicates the source of a secondarily reported record
The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
Should not be populated if primarySource = True, not required even if primarySource = False.
.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)
The service delivery location where the vaccine administration occurred.
RXA-27 (or RXA-11, deprecated as of v2.7)
Body site where vaccine was administered.
The path by which the vaccine product is taken into the body.
The quantity of vaccine product that was administered.
Indicates who performed the immunization event.
Describes the type of performance (e.g. ordering provider, administering provider, etc.).
The role a practitioner or organization plays in the immunization event.
Individual or organization who was performing
The practitioner or organization who performed the action.
When the individual practitioner who performed the action is known, it is best to send.
Referência literal e relativa para o profissional. A referência é feita no formato: "reference":"Practitioner/2.16.840.1.113883.13.237-{{cpf}}" ou "reference":"Practitioner/2.16.840.1.113883.13.236-{{cns}}".
Referência literal e relativa para a organização. A referência é feita no formato: "reference":"Organization/2.16.840.1.113883.13.36-{{cnes}}".
Extra information about the immunization that is not conveyed by the other attributes.
Reasons why the vaccine was administered.
The reason why a vaccine was administered.
Condition, Observation or DiagnosticReport that supports why the immunization was administered.
Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
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.
By default, a dose should be considered to be potent.
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.
Reason why a dose is considered to be subpotent.
The reason why a dose is considered to be subpotent.
Educational material presented to patient
Educational material presented to the patient (or guardian) at the time of vaccine administration.
One of documentType or reference SHALL be present
documentType.exists() or reference.exists()
exists(f:documentType) or exists(f:reference)
Educational material document identifier
Identifier of the material presented to the patient.
Reference pointer to the educational material given to the patient if the information was on line.
Date the educational material was published.
Date the educational material was given to the patient.
Patient eligibility for a vaccination program
Indicates a patient's eligibility for a funding program.
The patient's eligibility for a vaccation program.
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).
The source of funding used to purchase the vaccine administered.
Details of a reaction that follows immunization
Categorical data indicating that an adverse event is associated in time to an immunization.
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.
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)
(HL7 v2 doesn't seem to provide for this)
.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
The protocol (set of recommendations) being followed by the provider who administered the dose.
One possible path to achieve presumed immunity against a disease - within the context of an authority.
Who is responsible for publishing the recommendations
Indicates the authority who published the protocol (e.g. ACIP) that is being followed.
Vaccine preventatable disease being targetted
The vaccine preventable disease the dose is being administered against.
The vaccine preventable disease the dose is being administered for.
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).
Recommended number of doses for immunity
The recommended number of doses to achieve immunity.