---
:name: us_core_immunization
:class_name: USCorev311ImmunizationSequence
:version: v3.1.1
:reformatted_version: v311
:resource: Immunization
:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization
:profile_name: US Core Immunization Profile
:title: Immunization
:short_description: Verify support for the server capabilities required by the US
  Core Immunization Profile.
:interactions:
- :code: create
  :expectation: MAY
- :code: search-type
  :expectation: SHALL
- :code: read
  :expectation: SHALL
- :code: vread
  :expectation: SHOULD
- :code: update
  :expectation: MAY
- :code: patch
  :expectation: MAY
- :code: delete
  :expectation: MAY
- :code: history-instance
  :expectation: SHOULD
- :code: history-type
  :expectation: MAY
:operations: []
:searches:
- :names:
  - patient
  :expectation: SHALL
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
- :expectation: SHOULD
  :names:
  - patient
  - date
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
- :expectation: SHOULD
  :names:
  - patient
  - status
  :names_not_must_support_or_mandatory: []
  :must_support_or_mandatory: true
:search_definitions:
  :patient:
    :path: patient
    :full_path: Immunization.patient
    :comparators: {}
    :values: []
    :type: Reference
    :contains_multiple: false
    :multiple_or: MAY
  :date:
    :path: occurrence
    :full_path: Immunization.occurrence
    :comparators:
      :eq: MAY
      :ne: MAY
      :gt: SHALL
      :ge: SHALL
      :lt: SHALL
      :le: SHALL
      :sa: MAY
      :eb: MAY
      :ap: MAY
    :values: []
    :type: date
    :contains_multiple: false
    :multiple_or: MAY
  :status:
    :path: status
    :full_path: Immunization.status
    :comparators: {}
    :values:
    - completed
    - entered-in-error
    - not-done
    :type: code
    :contains_multiple: false
    :multiple_or: MAY
:include_params: []
:revincludes:
- Provenance:target
:required_concepts: []
:must_supports:
  :extensions: []
  :slices: []
  :elements:
  - :path: status
  - :path: statusReason
  - :path: vaccineCode
  - :path: patient
  - :path: occurrence[x]
  - :path: primarySource
:mandatory_elements:
- Immunization.status
- Immunization.vaccineCode
- Immunization.patient
- Immunization.occurrence[x]
- Immunization.primarySource
- Immunization.performer.actor
- Immunization.protocolApplied.doseNumber[x]
:bindings:
- :type: code
  :strength: preferred
  :system: http://hl7.org/fhir/ValueSet/languages
  :path: language
- :type: code
  :strength: required
  :system: http://hl7.org/fhir/ValueSet/immunization-status
  :path: status
- :type: CodeableConcept
  :strength: example
  :system: http://hl7.org/fhir/ValueSet/immunization-status-reason
  :path: statusReason
- :type: CodeableConcept
  :strength: extensible
  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-vaccines-cvx
  :path: vaccineCode
- :type: CodeableConcept
  :strength: example
  :system: http://hl7.org/fhir/ValueSet/immunization-origin
  :path: reportOrigin
- :type: CodeableConcept
  :strength: example
  :system: http://hl7.org/fhir/ValueSet/immunization-site
  :path: site
- :type: CodeableConcept
  :strength: example
  :system: http://hl7.org/fhir/ValueSet/immunization-route
  :path: route
- :type: CodeableConcept
  :strength: extensible
  :system: http://hl7.org/fhir/ValueSet/immunization-function
  :path: performer.function
- :type: CodeableConcept
  :strength: example
  :system: http://hl7.org/fhir/ValueSet/immunization-reason
  :path: reasonCode
- :type: CodeableConcept
  :strength: example
  :system: http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
  :path: subpotentReason
- :type: CodeableConcept
  :strength: example
  :system: http://hl7.org/fhir/ValueSet/immunization-program-eligibility
  :path: programEligibility
- :type: CodeableConcept
  :strength: example
  :system: http://hl7.org/fhir/ValueSet/immunization-funding-source
  :path: fundingSource
- :type: CodeableConcept
  :strength: example
  :system: http://hl7.org/fhir/ValueSet/immunization-target-disease
  :path: protocolApplied.targetDisease
:references:
- :path: Immunization.patient
  :profiles:
  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
- :path: Immunization.encounter
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Encounter
- :path: Immunization.location
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Location
- :path: Immunization.manufacturer
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Organization
- :path: Immunization.performer.actor
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Practitioner
  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
  - http://hl7.org/fhir/StructureDefinition/Organization
- :path: Immunization.reasonReference
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Condition
  - http://hl7.org/fhir/StructureDefinition/Observation
  - http://hl7.org/fhir/StructureDefinition/DiagnosticReport
- :path: Immunization.reaction.detail
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Observation
- :path: Immunization.protocolApplied.authority
  :profiles:
  - http://hl7.org/fhir/StructureDefinition/Organization
:tests:
- :id: us_core_311_immunization_patient_search_test
  :file_name: immunization_patient_search_test.rb
- :id: us_core_311_immunization_patient_date_search_test
  :file_name: immunization_patient_date_search_test.rb
- :id: us_core_311_immunization_patient_status_search_test
  :file_name: immunization_patient_status_search_test.rb
- :id: us_core_311_immunization_read_test
  :file_name: immunization_read_test.rb
- :id: us_core_311_immunization_provenance_revinclude_search_test
  :file_name: immunization_provenance_revinclude_search_test.rb
- :id: us_core_311_immunization_validation_test
  :file_name: immunization_validation_test.rb
- :id: us_core_311_immunization_must_support_test
  :file_name: immunization_must_support_test.rb
- :id: us_core_311_immunization_reference_resolution_test
  :file_name: immunization_reference_resolution_test.rb
:id: us_core_311_immunization
:file_name: immunization_group.rb
:delayed_references: []