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

StructureDefinition: Vaccine

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/medicationadministration-immunization-vaccine

Vaccine

This profile was published on Wed, Mar 18, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - [WG Name] WG.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Medication.

Summary

Required/Prohibited Elements

  • The element Medication.name is prohibited
  • The element Medication.isBrand is prohibited
  • The element Medication.product.form is prohibited
  • The element Medication.product.ingredient is prohibited
  • The element Medication.product.ingredient.item is prohibited
  • The element Medication.product.ingredient.amount is prohibited
  • The element Medication.package is prohibited

Fixed Values

  • The element Medication.kind value has been fixed to product

This structure is derived from Medication.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 1..1MedicationVaccine
... name 0..0
... code Vaccine Code
Binding: VaccineType (example)
... isBrand 0..0
... manufacturer Vaccine Manufacturer
... kind code(fixed value)
Fixed Value: product
... product
.... form 0..0
.... ingredient 0..0
.... batch
... package 0..0
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 1..1MedicationVaccine
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptVaccine Code
Binding: VaccineType (example)
... manufacturer Σ0..1OrganizationVaccine Manufacturer
... kind Σ0..1code(fixed value)
Binding: MedicationKind (required)
Fixed Value: product
... product 0..1Administrable medication details
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... batch 0..*Information about a group of medication produced or packaged from one production run.
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringThe assigned lot number of a batch of the specified product.
..... expirationDate 0..1dateTimeWhen this specific batch of product will expire.

todo

This structure is derived from Medication.

Summary

Required/Prohibited Elements

  • The element Medication.name is prohibited
  • The element Medication.isBrand is prohibited
  • The element Medication.product.form is prohibited
  • The element Medication.product.ingredient is prohibited
  • The element Medication.product.ingredient.item is prohibited
  • The element Medication.product.ingredient.amount is prohibited
  • The element Medication.package is prohibited

Fixed Values

  • The element Medication.kind value has been fixed to product

Differential View

This structure is derived from Medication.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 1..1MedicationVaccine
... name 0..0
... code Vaccine Code
Binding: VaccineType (example)
... isBrand 0..0
... manufacturer Vaccine Manufacturer
... kind code(fixed value)
Fixed Value: product
... product
.... form 0..0
.... ingredient 0..0
.... batch
... package 0..0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 1..1MedicationVaccine
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptVaccine Code
Binding: VaccineType (example)
... manufacturer Σ0..1OrganizationVaccine Manufacturer
... kind Σ0..1code(fixed value)
Binding: MedicationKind (required)
Fixed Value: product
... product 0..1Administrable medication details
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... batch 0..*Information about a group of medication produced or packaged from one production run.
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringThe assigned lot number of a batch of the specified product.
..... expirationDate 0..1dateTimeWhen this specific batch of product will expire.

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

Terminology Bindings

PathNameConformanceValueSet
Medication.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Medication.codeVaccineTypeexampleVaccine Administered Value Set
Medication.kindMedicationKindrequiredMedicationKind
Medication.product.formMedicationFormexampleSNOMED CT Form Codes
Medication.package.containerMedicationContainerexampleSNOMED CT Form Codes

Constraints

IdPathNameDetails
.