2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile Clinical Quality Framework (CQF) Immunization Recommendation Profile - Definitions

Todo

Definitions for the cqf-immunizationrecommendation-cqf-immunizationrecommendation Profile.

ImmunizationRecommendation(cqf-immunizationrecommendation)
Definition

A patient's point-of-time immunization status and recommendation with optional supporting justification.

Control1..1
Requirements
Comments
ImmunizationRecommendation.id
Definition

The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.

Control0..1
Typeid
Requirements
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. Bundles always have an id, though it is usually a generated UUID.

ImmunizationRecommendation.meta
Definition

The 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.

Control0..1
TypeMeta
Requirements
Comments
ImmunizationRecommendation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Requirements
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 as much as possible.

ImmunizationRecommendation.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements
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).

ImmunizationRecommendation.text
Definition

A 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Requirements
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

ImmunizationRecommendation.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Requirements
Alternate Namesinline 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.

ImmunizationRecommendation.extension
Definition

May 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

ImmunizationRecommendation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

ImmunizationRecommendation.identifier
Definition

A unique identifier assigned to this particular recommendation record.

Control0..*
TypeIdentifier
Requirements
Comments
ImmunizationRecommendation.patient
Definition

The patient for whom the recommendations are for.

Control1..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Must Supporttrue
Requirements
Comments
ImmunizationRecommendation.recommendation
Definition

Vaccine administration recommendations.

Control1..*
Must Supporttrue
Requirements
Comments
ImmunizationRecommendation.recommendation.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
ImmunizationRecommendation.recommendation.extension
Definition

May 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

ImmunizationRecommendation.recommendation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

ImmunizationRecommendation.recommendation.date
Definition

The date the immunization recommendation was created.

Control1..1
TypedateTime
Must Supporttrue
Requirements
Comments
ImmunizationRecommendation.recommendation.vaccineType
Definition

Vaccine that pertains to the recommendation.

Control1..1
BindingThe type of vaccine administered
For example codes, see v3 Code System VaccineType
TypeCodeableConcept
Must Supporttrue
Requirements
Comments
ImmunizationRecommendation.recommendation.doseNumber
Definition

This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).

Control0..1
Typeinteger
Must Supporttrue
Requirements
Comments

May need other dose concepts such as administered vs. valid.

ImmunizationRecommendation.recommendation.forecastStatus
Definition

Vaccine administration status.

Control1..1
BindingThe patient's status with respect to a vaccination protocol
For example codes, see Immunization Recommendation Status Codes
TypeCodeableConcept
Requirements
Comments
ImmunizationRecommendation.recommendation.dateCriterion
Definition

Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc.

Control0..*
Must Supporttrue
Requirements
Comments
ImmunizationRecommendation.recommendation.dateCriterion.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
ImmunizationRecommendation.recommendation.dateCriterion.extension
Definition

May 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

ImmunizationRecommendation.recommendation.dateCriterion.code
Definition

Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.

Control1..1
BindingClassifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)
For example codes, see Immunization Recommendation Date Criterion Codes
TypeCodeableConcept
Requirements
Comments
ImmunizationRecommendation.recommendation.dateCriterion.value
Definition

Date recommendation.

Control1..1
TypedateTime
Must Supporttrue
Requirements
Comments
ImmunizationRecommendation.recommendation.protocol
Definition

Contains information about the protocol under which the vaccine was administered.

Control0..1
Must Supporttrue
Requirements
Comments
ImmunizationRecommendation.recommendation.protocol.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
ImmunizationRecommendation.recommendation.protocol.extension
Definition

May 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

ImmunizationRecommendation.recommendation.protocol.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, 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.

ImmunizationRecommendation.recommendation.protocol.doseSequence
Definition

Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.

Control0..1
Typeinteger
Must Supporttrue
Requirements
Comments
ImmunizationRecommendation.recommendation.protocol.description
Definition

Contains the description about the protocol under which the vaccine was administered.

Control0..1
Typestring
Requirements
Comments
ImmunizationRecommendation.recommendation.protocol.authority
Definition

Indicates the authority who published the protocol? E.g. ACIP.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Requirements
Comments
ImmunizationRecommendation.recommendation.protocol.series
Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Control0..1
Typestring
Must Supporttrue
Requirements
Comments
ImmunizationRecommendation.recommendation.supportingImmunization
Definition

Immunization event history that supports the status and recommendation.

Control0..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Immunization))
Requirements
Comments
ImmunizationRecommendation.recommendation.supportingPatientInformation
Definition

Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

Control0..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Observation)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/AllergyIntolerance))
Requirements
Comments