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

Extension What protocol was followed - Definition

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/immunization-protocol

Status: draft. Extension maintained by: Health Level Seven, Inc. - [WG Name] WG

Contains information about the protocol(s) under which the vaccine was administered.

Context of Use: Use on element: MedicationAdministration

usage info: insert a list of places where this extension is used

Extension Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extensionExtensionURL = http://hl7.org/fhir/StructureDefinition/immunization-protocol
What protocol was followed: Contains information about the protocol(s) under which the vaccine was administered.
Use on element: MedicationAdministration
... extension 1..1ExtensionWhat dose number within series?
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: doseSequence
.... valueInteger 0..1integerValue of extension
... extension 0..1ExtensionDetails of vaccine protocol
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: description
.... valueString 0..1stringValue of extension
... extension 0..1ExtensionWho is responsible for protocol
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: authority
.... valueReference 0..1OrganizationValue of extension
... extension 0..1ExtensionName of vaccine series
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: series
.... valueString 0..1stringValue of extension
... extension 0..1ExtensionRecommended number of doses for immunity
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: seriesDoses
.... valueInteger 0..1integerValue of extension
... extension 1..1ExtensionDisease immunized against
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: doseTarget
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: VaccinationProtocolDoseTarget (example)
... extension 1..1ExtensionDoes dose count towards immunity?
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: doseStatus
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: VaccinationProtocolDoseStatus (example)
... extension 0..1ExtensionWhy does does count/not count?
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: doseStatusReason
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: VaccinationProtocolDoseStatusReason (example)
... url 1..1uriidentifies the meaning of the extension
Fixed Value: http://hl7.org/fhir/StructureDefinition/immunization-protocol
... value[x] 0..0*

XML Template

<!-- What protocol was followed -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/immunization-protocol" >
  <!-- from Element: extension -->
 <valueInteger  value="[integer]"/><!-- 0..1 Value of extension
 <valueString  value="[string]"/><!-- 0..1 Value of extension
 <valueReference ><!-- 0..1 Reference 
     Value of extension
 <valueString  value="[string]"/><!-- 0..1 Value of extension
 <valueInteger  value="[integer]"/><!-- 0..1 Value of extension
 <valueCodeableConcept ><!-- 0..1 CodeableConcept Value of extension
 <valueCodeableConcept ><!-- 0..1 CodeableConcept Value of extension
 <valueCodeableConcept ><!-- 0..1 CodeableConcept Value of extension
 <value* ><!-- 0..0 * Value of extension
</extension>

JSON Template

{ // What protocol was followed
  // from Element: extension
    "url" : "doseSequence", // R! 
    "valueInteger" : <integer>, //Value of extension
    "url" : "description", // R! 
    "valueString" : "<string>", //Value of extension
    "url" : "authority", // R! 
    "valueReference" : { Reference(http://hl7.org/fhir/StructureDefinition/Organization) }, //Value of extension
    "url" : "series", // R! 
    "valueString" : "<string>", //Value of extension
    "url" : "seriesDoses", // R! 
    "valueInteger" : <integer>, //Value of extension
    "url" : "doseTarget", // R! 
    "valueCodeableConcept" : { CodeableConcept }, //Value of extension
    "url" : "doseStatus", // R! 
    "valueCodeableConcept" : { CodeableConcept }, //Value of extension
    "url" : "doseStatusReason", // R! 
    "valueCodeableConcept" : { CodeableConcept }, //Value of extension
    "url" : "http://hl7.org/fhir/StructureDefinition/immunization-protocol", // R! 
    "value*" : { * } //Value of extension
  }

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extensionExtensionURL = http://hl7.org/fhir/StructureDefinition/immunization-protocol
What protocol was followed: Contains information about the protocol(s) under which the vaccine was administered.
Use on element: MedicationAdministration
... extension 1..1ExtensionWhat dose number within series?
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: doseSequence
.... valueInteger 0..1integerValue of extension
... extension 0..1ExtensionDetails of vaccine protocol
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: description
.... valueString 0..1stringValue of extension
... extension 0..1ExtensionWho is responsible for protocol
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: authority
.... valueReference 0..1OrganizationValue of extension
... extension 0..1ExtensionName of vaccine series
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: series
.... valueString 0..1stringValue of extension
... extension 0..1ExtensionRecommended number of doses for immunity
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: seriesDoses
.... valueInteger 0..1integerValue of extension
... extension 1..1ExtensionDisease immunized against
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: doseTarget
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: VaccinationProtocolDoseTarget (example)
... extension 1..1ExtensionDoes dose count towards immunity?
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: doseStatus
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: VaccinationProtocolDoseStatus (example)
... extension 0..1ExtensionWhy does does count/not count?
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
Fixed Value: doseStatusReason
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: VaccinationProtocolDoseStatusReason (example)
... url 1..1uriidentifies the meaning of the extension
Fixed Value: http://hl7.org/fhir/StructureDefinition/immunization-protocol
... value[x] 0..0*

XML Template

<!-- What protocol was followed -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/immunization-protocol" >
  <!-- from Element: extension -->
 <valueInteger  value="[integer]"/><!-- 0..1 Value of extension
 <valueString  value="[string]"/><!-- 0..1 Value of extension
 <valueReference ><!-- 0..1 Reference 
     Value of extension
 <valueString  value="[string]"/><!-- 0..1 Value of extension
 <valueInteger  value="[integer]"/><!-- 0..1 Value of extension
 <valueCodeableConcept ><!-- 0..1 CodeableConcept Value of extension
 <valueCodeableConcept ><!-- 0..1 CodeableConcept Value of extension
 <valueCodeableConcept ><!-- 0..1 CodeableConcept Value of extension
 <value* ><!-- 0..0 * Value of extension
</extension>

JSON Template

to do

 

Terminology Bindings

PathDefinitionTypeReference
http://hl7.org/fhir/StructureDefinition/immunization-protocol The disease target of the vaccination protocolExamplehttp://hl7.org/fhir/vs/vaccination-protocol-dose-target
http://hl7.org/fhir/StructureDefinition/immunization-protocol The status of the vaccination protocol (i.e. should this count)Examplehttp://hl7.org/fhir/vs/vaccination-protocol-dose-status
http://hl7.org/fhir/StructureDefinition/immunization-protocol The reason for the determining if a vaccination should count or why vaccination should not count.Examplehttp://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason