Generated Narrative: StructureDefinition ImmunizationEvaluation Last updated: 2021-01-02 08:58:31+1100 Name Flags Card. Type Description & Constraints ImmunizationEvaluation 0..* DomainResource Immunization evaluation information Elements defined in Ancestors:id, meta, implicitRules, language, <a href="http://hl7.org/fhir/R5/domainresource.html" title="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.">text, contained, <a href="http://hl7.org/fhir/R5/domainresource.html" title="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 managable, 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.">extension, <a href="http://hl7.org/fhir/R5/domainresource.html" title="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 managable, 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.#xA;#xA;Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).">modifierExtension #xD; identifier 0..* Identifier Business identifier #xD; status ?!Σ 1..1 code completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done. #xD; patient Σ 1..1 Reference(Patient) Who this evaluation is for #xD; date 0..1 dateTime Date evaluation was performed #xD; authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations #xD; targetDisease Σ 1..1 CodeableConcept The vaccine preventable disease schedule being evaluated Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being evaluated against. #xD; immunizationEvent Σ 1..1 Reference(Immunization) Immunization being evaluated #xD; doseStatus Σ 1..1 CodeableConcept Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (example): The status of the administered dose relative to the published recommendations for the target disease. #xD; doseStatusReason 0..* CodeableConcept Reason why the doese is considered valid, invalid or some other status Binding: ImmunizationEvaluationDoseStatusReasonCodes (example): The reason the dose status was assigned. #xD; description 0..1 markdown Evaluation notes #xD; series 0..1 string Name of vaccine series #xD; doseNumber 0..1 CodeableConcept Dose number within series Binding Description: (example): A code expressing the vaccine dose number - several coding schemes exist or will be defined for each jurisdiction. #xD; seriesDoses 0..1 CodeableConcept Recommended number of doses for immunity Binding Description: (example): A code expressing the doses recommended or expected - several coding schemes exist or will be defined for each jurisdiction. #xD; Documentation for this format
Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
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()
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
Entity. Role, or Act,Entity, Role, or Act
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
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 its 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 its 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 a 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
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. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](http://build.fhir.org/resource.html#additional).
Extensions are always sliced by (at least) url
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 managable, 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.
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 managable, 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://build.fhir.org/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
A unique identifier assigned to this immunization evaluation record.
Indicates the current status of the evaluation of the vaccination administration event.
This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid).
The status of the evaluation being done.
The individual for whom the evaluation is being done.
The date the evaluation of the vaccine administration event was performed.
Who is responsible for publishing the recommendations
Indicates the authority who published the protocol (e.g. ACIP).
The vaccine preventable disease schedule being evaluated
The vaccine preventable disease the dose is being evaluated against.
The vaccine administration event being evaluated.
Status of the dose relative to published recommendations
Indicates if the dose is valid or not valid with respect to the published recommendations.
The status of the administered dose relative to the published recommendations for the target disease.
Reason why the doese is considered valid, invalid or some other status
Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
The reason the dose status was assigned.
Additional information about the evaluation.
One possible path to achieve presumed immunity against a disease - within the context of an authority.
#13185 (add option for string), #25277 (restrict to string data type).
Nominal position in a series as determined by the outcome of the evaluation process.
The dose number may be communicated as either a coded concept (for example Dose 1, Dose 2 or Booster) or as free text as needed by the use case.
A code expressing the vaccine dose number - several coding schemes exist or will be defined for each jurisdiction.
Recommended number of doses for immunity
The recommended number of doses to achieve immunity as determined by the outcome of the evaluation process.
The number of doses in a series may be communicated as either a coded concept or as free text as needed by the use case.
A code expressing the doses recommended or expected - several coding schemes exist or will be defined for each jurisdiction.