FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/Immunization

Packageca.healthpei.io.core
Resource TypeStructureDefinition
IdImmunization
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=ca.healthpei.io.core@0.1.7-DFT&canonical=http://healthpei.ca/fhir/StructureDefinition/ca-pei-profile-Immunization
URLhttp://healthpei.ca/fhir/StructureDefinition/ca-pei-profile-Immunization
Statusdraft
NameImmunization
TitleImmunization
DescriptionDescribes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
TypeImmunization
Kindresource

Resources that use this resource

No resources found


Resources that this resource uses

ValueSet
Disease
RouteOfAdminRoute Of Administration
Tradename
ca-pe-code-immunization-sitePEI Immunization Site Codes
ca-pei-vaccine-commonPEI Common Vaccine Codes ValueSet
ca-pei-vaccine-tradenamePEI Tradename Vaccine Codes ValueSet
GenericGenericImmunizingAgent
ca-pei-cs-PEIImmunizationStatusImmunizationStatusReason

Narrative

No narrative content found in resource


Source

{
  "resourceType": "StructureDefinition",
  "id": "Immunization",
  "url": "http://healthpei.ca/fhir/StructureDefinition/ca-pei-profile-Immunization",
  "name": "Immunization",
  "title": "Immunization",
  "status": "draft",
  "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Immunization",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Immunization.identifier",
        "path": "Immunization.identifier",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Immunization.identifier.system",
        "path": "Immunization.identifier.system",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Immunization.identifier.value",
        "path": "Immunization.identifier.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Immunization.status",
        "path": "Immunization.status",
        "mustSupport": true
      },
      {
        "id": "Immunization.statusReason",
        "path": "Immunization.statusReason",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "http://healthpei.ca/fhir/pei/ValueSet/ca-pei-cs-PEIImmunizationStatus"
        }
      },
      {
        "id": "Immunization.statusReason.coding",
        "path": "Immunization.statusReason.coding",
        "mustSupport": true
      },
      {
        "id": "Immunization.statusReason.coding.system",
        "path": "Immunization.statusReason.coding.system",
        "mustSupport": true
      },
      {
        "id": "Immunization.statusReason.coding.code",
        "path": "Immunization.statusReason.coding.code",
        "mustSupport": true
      },
      {
        "id": "Immunization.statusReason.coding.display",
        "path": "Immunization.statusReason.coding.display",
        "mustSupport": true
      },
      {
        "id": "Immunization.vaccineCode",
        "path": "Immunization.vaccineCode",
        "mustSupport": true,
        "binding": {
          "strength": "preferred",
          "valueSet": "http://hl7.org/fhir/ValueSet/vaccine-code",
          "extension": [
            {
              "extension": [
                {
                  "url": "purpose",
                  "valueCode": "candidate"
                },
                {
                  "url": "valueSet",
                  "valueCanonical": "https://princeedwardisland.ca/fhir/ValueSet/ca-pei-vaccine-common"
                },
                {
                  "url": "documentation",
                  "valueMarkdown": "This is the PEI specific code, referred to as Vaccine Common."
                }
              ],
              "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
            },
            {
              "extension": [
                {
                  "url": "purpose",
                  "valueCode": "candidate"
                },
                {
                  "url": "valueSet",
                  "valueCanonical": "https://princeedwardisland.ca/fhir/ValueSet/ca-pei-vaccine-tradename"
                },
                {
                  "url": "documentation",
                  "valueMarkdown": "This is the PEI specific code for Tradename."
                }
              ],
              "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
            },
            {
              "extension": [
                {
                  "url": "purpose",
                  "valueCode": "candidate"
                },
                {
                  "url": "valueSet",
                  "valueCanonical": "https://nvc-cnv.canada.ca/v1/ValueSet/Generic"
                },
                {
                  "url": "documentation",
                  "valueMarkdown": "This is the National Vaccine Catalog code for the Generic."
                }
              ],
              "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
            },
            {
              "extension": [
                {
                  "url": "purpose",
                  "valueCode": "candidate"
                },
                {
                  "url": "valueSet",
                  "valueCanonical": "https://nvc-cnv.canada.ca/fhir/v2/ValueSet/Tradename"
                },
                {
                  "url": "documentation",
                  "valueMarkdown": "This is the National Vaccine Catalog code for the Tradename."
                }
              ],
              "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
            }
          ]
        }
      },
      {
        "id": "Immunization.vaccineCode.coding",
        "path": "Immunization.vaccineCode.coding",
        "mustSupport": true
      },
      {
        "id": "Immunization.vaccineCode.coding.system",
        "path": "Immunization.vaccineCode.coding.system",
        "mustSupport": true
      },
      {
        "id": "Immunization.vaccineCode.coding.code",
        "path": "Immunization.vaccineCode.coding.code",
        "mustSupport": true
      },
      {
        "id": "Immunization.vaccineCode.coding.display",
        "path": "Immunization.vaccineCode.coding.display",
        "mustSupport": true
      },
      {
        "id": "Immunization.patient",
        "path": "Immunization.patient",
        "mustSupport": true
      },
      {
        "id": "Immunization.patient.reference",
        "path": "Immunization.patient.reference",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Immunization.occurrence[x]",
        "path": "Immunization.occurrence[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "ordered": false,
          "rules": "open"
        },
        "mustSupport": true
      },
      {
        "id": "Immunization.occurrence[x]:occurrenceDateTime",
        "path": "Immunization.occurrence[x]",
        "sliceName": "occurrenceDateTime",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Immunization.recorded",
        "path": "Immunization.recorded",
        "mustSupport": true
      },
      {
        "id": "Immunization.reportOrigin",
        "path": "Immunization.reportOrigin",
        "mustSupport": true
      },
      {
        "id": "Immunization.reportOrigin.coding",
        "path": "Immunization.reportOrigin.coding",
        "mustSupport": true
      },
      {
        "id": "Immunization.location",
        "path": "Immunization.location",
        "mustSupport": true
      },
      {
        "id": "Immunization.location.reference",
        "path": "Immunization.location.reference",
        "mustSupport": true
      },
      {
        "id": "Immunization.manufacturer",
        "path": "Immunization.manufacturer",
        "mustSupport": true
      },
      {
        "id": "Immunization.lotNumber",
        "path": "Immunization.lotNumber",
        "mustSupport": true
      },
      {
        "id": "Immunization.site",
        "path": "Immunization.site",
        "mustSupport": true,
        "binding": {
          "strength": "preferred",
          "valueSet": "https://nvc-cnv.canada.ca/fhir/v2/ValueSet/RouteOfAdmin",
          "extension": [
            {
              "extension": [
                {
                  "url": "purpose",
                  "valueCode": "candidate"
                },
                {
                  "url": "valueSet",
                  "valueCanonical": "https://princeedwardisland.ca/fhir/ValueSet/ca-pe-code-immunization-site"
                },
                {
                  "url": "documentation",
                  "valueMarkdown": "This is the PEI specific code, referred to as Vaccine Common."
                }
              ],
              "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
            }
          ]
        }
      },
      {
        "id": "Immunization.site.coding",
        "path": "Immunization.site.coding",
        "mustSupport": true
      },
      {
        "id": "Immunization.site.coding.system",
        "path": "Immunization.site.coding.system",
        "mustSupport": true
      },
      {
        "id": "Immunization.site.coding.code",
        "path": "Immunization.site.coding.code",
        "mustSupport": true
      },
      {
        "id": "Immunization.site.coding.display",
        "path": "Immunization.site.coding.display",
        "mustSupport": true
      },
      {
        "id": "Immunization.protocolApplied",
        "path": "Immunization.protocolApplied",
        "mustSupport": true
      },
      {
        "id": "Immunization.protocolApplied.targetDisease",
        "path": "Immunization.protocolApplied.targetDisease",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "https://nvc-cnv.canada.ca/fhir/v2/ValueSet/Disease"
        }
      },
      {
        "id": "Immunization.protocolApplied.doseNumber[x]",
        "path": "Immunization.protocolApplied.doseNumber[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "ordered": false,
          "rules": "open"
        },
        "mustSupport": true
      },
      {
        "id": "Immunization.protocolApplied.doseNumber[x]:doseNumberString",
        "path": "Immunization.protocolApplied.doseNumber[x]",
        "sliceName": "doseNumberString",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mustSupport": true
      }
    ]
  }
}