{
  "description": "Defines the clinical and patient information contained within a SMART Health Card (SHC) related to vaccination and lab results related to an infectious disease like COVID-19.",
  "_filename": "ig-r4.json",
  "package_name": "hl7.fhir.uv.shc-vaccination",
  "definition": {
    "page": {
      "page": [ {
        "title": "Home",
        "nameUrl": "index.html",
        "generation": "markdown"
      }, {
        "title": "Conformance",
        "nameUrl": "conformance.html",
        "generation": "markdown"
      }, {
        "title": "Contact",
        "nameUrl": "contact.html",
        "generation": "markdown"
      }, {
        "title": "Laboratory Results Observation",
        "nameUrl": "laboratory-results-observation.html",
        "generation": "markdown"
      }, {
        "title": "Patient",
        "nameUrl": "patient.html",
        "generation": "markdown"
      }, {
        "title": "Profiles",
        "nameUrl": "profiles.html",
        "generation": "markdown"
      }, {
        "title": "Structure Definition Shc Covid 19 Laboratory Bundle Resource Examples",
        "nameUrl": "StructureDefinition-shc-covid19-laboratory-bundle-resource-examples.html",
        "generation": "markdown"
      }, {
        "title": "Structure Definition Shc Covid 19 Laboratory Result Observation Resource Examples",
        "nameUrl": "StructureDefinition-shc-covid19-laboratory-result-observation-resource-examples.html",
        "generation": "markdown"
      }, {
        "title": "Structure Definition Shc Infectious Disease Laboratory Bundle Resource Examples",
        "nameUrl": "StructureDefinition-shc-infectious-disease-laboratory-bundle-resource-examples.html",
        "generation": "markdown"
      }, {
        "title": "Structure Definition Shc Infectious Disease Laboratory Result Observation Resource Examples",
        "nameUrl": "StructureDefinition-shc-infectious-disease-laboratory-result-observation-resource-examples.html",
        "generation": "markdown"
      }, {
        "title": "Structure Definition Shc Patient General Resource Examples",
        "nameUrl": "StructureDefinition-shc-patient-general-resource-examples.html",
        "generation": "markdown"
      }, {
        "title": "Structure Definition Shc Patient Us Resource Examples",
        "nameUrl": "StructureDefinition-shc-patient-us-resource-examples.html",
        "generation": "markdown"
      }, {
        "title": "Structure Definition Shc Vaccination Bundle Resource Examples",
        "nameUrl": "StructureDefinition-shc-vaccination-bundle-resource-examples.html",
        "generation": "markdown"
      }, {
        "title": "Structure Definition Shc Vaccination Resource Examples",
        "nameUrl": "StructureDefinition-shc-vaccination-resource-examples.html",
        "generation": "markdown"
      }, {
        "title": "Vaccination",
        "nameUrl": "vaccination.html",
        "generation": "markdown"
      } ],
      "title": "Table of Contents",
      "nameUrl": "toc.html",
      "generation": "html"
    },
    "resource": [ {
      "name": "COVID-19-specific Laboratory Test Results Bundle - Allowable Data",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-covid19-laboratory-bundle-ad"
      },
      "description": "The bundle of resources that represents the patient identification and clinical content of a SMART Health Card with lab results, specifically for COVID-19.",
      "exampleBoolean": false
    }, {
      "name": "COVID-19-specific Laboratory Test Results Bundle - Data Minimization",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-covid19-laboratory-bundle-dm"
      },
      "description": "The bundle of resources that represents the clinical content of a digital lab credential record specifically for COVID-19 data minimization.",
      "exampleBoolean": false
    }, {
      "name": "COVID-19 Laboratory Result Observation Profile - Allowable Data",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-covid19-laboratory-result-observation-ad"
      },
      "description": "Profile for reporting COVID-19-related laboratory results indicating current or\nprevious infection status.",
      "exampleBoolean": false
    }, {
      "name": "COVID-19 Laboratory Result Observation Profile - Data Minimization",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-covid19-laboratory-result-observation-dm"
      },
      "description": "Profile for reporting COVID-19-related laboratory results indicating current or\nprevious infection status. Only elements necessary for Verifiers can be populated.",
      "exampleBoolean": false
    }, {
      "name": "Infectious Disease (Generic) Laboratory Test Results Bundle - Allowable Data",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-infectious-disease-laboratory-bundle-ad"
      },
      "description": "The bundle of resources that represents the patient identification and clinical content of a SMART Health Card with lab results.",
      "exampleBoolean": false
    }, {
      "name": "Infectious Disease (Generic) Laboratory Test Results Bundle - Data Minimization",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-infectious-disease-laboratory-bundle-dm"
      },
      "description": "The bundle of resources that represents the patient identification and clinical content of a SMART Health Card with lab results.",
      "exampleBoolean": false
    }, {
      "name": "Generic Laboratory Result Observation Profile - Allowable Data",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-infectious-disease-laboratory-result-observation-ad"
      },
      "description": "Profile for reporting laboratory results indicating current or previous infection status for a disease without a specified laboratory result profile.",
      "exampleBoolean": false
    }, {
      "name": "Generic Laboratory Result Observation Profile - Data Minimization",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-infectious-disease-laboratory-result-observation-dm"
      },
      "description": "Profile for reporting laboratory results indicating current or previous infection status for a disease without a specified laboratory result profile.\nOnly elements necessary for Verifiers can be populated.",
      "exampleBoolean": false
    }, {
      "name": "Patient Profile - General - Allowable Data",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-patient-general-ad"
      },
      "description": "Slight modification of Patient, with identifier as 0..0 and limited MS. For general use if no geographic-specific profile exists.",
      "exampleBoolean": false
    }, {
      "name": "Patient Profile - General - Data Minimization",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-patient-general-dm"
      },
      "description": "Only elements necessary for Verifiers can be populated. For general use if no geographic-specific profile exists.",
      "exampleBoolean": false
    }, {
      "name": "Patient Profile - United States - Allowable Data",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-patient-us-ad"
      },
      "description": "Only elements necessary for Verifiers can be populated.",
      "exampleBoolean": false
    }, {
      "name": "Patient Profile - United States - Data Minimization",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-patient-us-dm"
      },
      "description": "Only elements necessary for Verifiers can be populated. For use in the United States.",
      "exampleBoolean": false
    }, {
      "name": "Vaccination Profile - Allowable Data",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-vaccination-ad"
      },
      "description": "Defines a profile representing a vaccination for a SMART Health Card.",
      "exampleBoolean": false
    }, {
      "name": "Vaccination Bundle - Allowable Data",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-vaccination-bundle-ad"
      },
      "description": "The bundle of resources that represents the patient identification and clinical content of a SMART Health Card for vaccinations.",
      "exampleBoolean": false
    }, {
      "name": "Vaccination Bundle - Data Minimization",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-vaccination-bundle-dm"
      },
      "description": "The bundle of resources that represents the patient identification and clinical content of a SMART Health Card for vaccinations.",
      "exampleBoolean": false
    }, {
      "name": "Vaccination Profile - Data Minimization",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "StructureDefinition:resource"
      } ],
      "reference": {
        "reference": "StructureDefinition/shc-vaccination-dm"
      },
      "description": "Defines a profile representing a vaccination for a SMART Health Card. Only elements necessary for Verifiers can be populated.",
      "exampleBoolean": false
    }, {
      "name": "Identity Assurance Level",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/identity-assurance-level"
      },
      "description": "Relevant identity assurance level codes, based on NIST 800-63-3. See  for details.",
      "exampleBoolean": false
    }, {
      "name": "Lab result findings",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/lab-result-findings"
      },
      "description": "This value set includes SNOMED CT and LOINC codes for identifying laboratory test results.\n\nNote that we plan to change this value set to include only children of `441742003` (\"Evaluation finding (finding)\")\ninstead of `404684003` (\"Clinical finding (finding)\"), but currently value set expansion is\nnot working with this code in the IG Publisher.",
      "exampleBoolean": false
    }, {
      "name": "Lab result findings - SNOMED CT",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/lab-result-findings-snomed"
      },
      "description": "This value set includes SNOMED CT codes for identifying laboratory test results.",
      "exampleBoolean": false
    }, {
      "name": "Qualitative lab result findings",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/qualitative-lab-result-findings"
      },
      "description": "This value set includes codes for identifying laboratory test results. It includes SNOMED CT codes from a [value set of COVID-19-related SNOMED CT codes](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1114.10/expansion), as well as codes from LOINC answer lists with roughly equivalent meanings. While the source value set is COVID-19-related, these codes should apply to all infectious disease-related qualitative laboratory results.",
      "exampleBoolean": false
    }, {
      "name": "Qualitative lab results - LOINC",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/qualitative-lab-results-loinc"
      },
      "description": "This value set includes codes from LOINC answer lists with roughly equivalent meanings to the codes in this [value set of COVID-19-related SNOMED CT codes](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1114.10/expansion).",
      "exampleBoolean": false
    }, {
      "name": "Vaccine: ATC/DDD",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/vaccine-atc"
      },
      "description": "This value set includes the subset of [ATC](http://www.whocc.no/atc_ddd_index/?code=J07) that identify vaccine targets.\n\nNote that an ATC code for COVID-19 vaccines (`J07BX03`) [has been created](https://www.who.int/medicines/publications/druginformation/issues/WHO_DI_34_4_ATC-DDD_ClassificationTemp.pdf) and will be added to the next published version of ATC/DDD slated for January 2022.",
      "exampleBoolean": false
    }, {
      "name": "Vaccine: CVX",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/vaccine-cvx"
      },
      "description": "This value set includes all [CVX](https://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=cvx) codes, which identify vaccine products.",
      "exampleBoolean": false
    }, {
      "name": "Vaccine: GTIN",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/vaccine-gtin"
      },
      "description": "This value set includes all [GTIN](https://www.gs1.org/gtin) codes, rather than just the vaccine-related GTINs. This is because there is not a way to filter GTINs to a specific category of product. For more information about GTINs see the [Vaccination profile group information page](vaccination.html).",
      "exampleBoolean": false
    }, {
      "name": "Vaccine: ICD-11",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/vaccine-icd-11"
      },
      "description": "This value set includes the subset of [ICD-11](https://icd.who.int/en) that identify vaccine types.\n\nNote that the COVID-related ICD-11 vaccine codes are not in the `09/2020` version of ICD-11. They\ncan be found on the [maintenance platform](https://icd.who.int/dev11/l-m/en), and include:\n\n* `XM1NL1`: COVID-19 vaccine, inactivated virus\n* `XM5DF6`: COVID-19 vaccine, live attenuated virus\n* `XM9QW8`: COVID-19 vaccine, non-replicating viral vector\n* `XM0CX4`: COVID-19 vaccine, replicating viral vector\n* `XM5JC5`: COVID-19 vaccine, virus protein subunit\n* `XM1J92`: COVID-19 vaccine, virus like particle (VLP)\n* `XM6AT1`: COVID-19 vaccine, DNA based\n* `XM0GQ8`: COVID-19 vaccine, RNA based\n\nImplementers should consider the [ICD-11 maintenance platform](https://icd.who.int/dev11/l-m/en)\nthe canonical source of ICD-11 codes for COVID-19 vaccines.\n\nNote that this value set should contain the same codes as the [WHO Vaccine List value set](https://who-int.github.io/svc/ValueSet-who-svc-vaccines.html),\nand may be replaced with the WHO value set once that is published.",
      "exampleBoolean": false
    }, {
      "name": "Vaccine: SNOMED CT",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/vaccine-snomed"
      },
      "description": "This value set includes codes identifying vaccine products from SNOMED Clinical Terms®,\nspecifically descendants of [`787859002` (\"Vaccine product\")](http://browser.ihtsdotools.org/?perspective=full&conceptId1=787859002).\n\n**Descendants of this code from *any* edition of SNOMED CT MAY be used in elements bound to this value set.** All\nSNOMED codes regardless of edition share the same canonical URI (`http://snomed.info/sct`), which\nmeans that from a conformance perspective, this value set does not differentiate between [SNOMED CT editions].\n\nHowever, successfully validating resources with elements bound to this value set requires\na terminology server that supports the SNOMED edition used by the implementer.\n\nThe terminology server used for publishing this Implementation Guide (`tx.fhir.org`)\nsupports the following [SNOMED CT editions] as of publishing:\n\n- International\n- Australia\n- Canada\n\nThe relevant codes from these SNOMED CT editions are included in the value set expansion below.\n\n**Note that this value set expansion  may be out of date, and may not include COVID-19-related\ncodes.** Implementers SHALL defer to [the canonical list of COVID-19-related SNOMED International codes][snomed-covid],\nor the national edition equivalent, for COVID-related vaccines when it does not match the codes listed below.\n\nNote that some of the SNOMED-CT codes that are part of this value set expansion,\n[including the COVID-19-related SNOMED codes](https://confluence.ihtsdotools.org/display/snomed/SNOMED+CT+COVID-19+Related+Content), may be used under the a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/) as part of [the SNOMED Global Patient Set](https://gps.snomed.org). Please refer to [https://gps.snomed.org](https://gps.snomed.org) to determine which specific SNOMED codes may be used under this license.\n\n[SNOMED CT editions]: https://confluence.ihtsdotools.org/display/DOCEXTPG/4.4.2+Edition+URI+Examples\n[snomed-covid]: https://confluence.ihtsdotools.org/display/snomed/SNOMED+CT+COVID-19+Related+Content",
      "exampleBoolean": false
    }, {
      "name": "Identity Assurance Level Code System",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CodeSystem"
      } ],
      "reference": {
        "reference": "CodeSystem/identity-assurance-level-code-system"
      },
      "description": "Code representing identity assurance level, based on NIST 800-63-3",
      "exampleBoolean": false
    } ],
    "parameter": [ {
      "code": "copyrightyear",
      "value": "2021+"
    }, {
      "code": "releaselabel",
      "value": "STU 1 (Ballot Version)"
    }, {
      "code": "liquid-path",
      "value": "liquid"
    }, {
      "code": "active-tables",
      "value": "true"
    }, {
      "code": "excludettl",
      "value": "true"
    }, {
      "code": "excludexml",
      "value": "true"
    }, {
      "code": "path-history",
      "value": "http://hl7.org/fhir/uv/shc-vaccination/history.html"
    }, {
      "code": "autoload-resources",
      "value": "true"
    }, {
      "code": "path-resource",
      "value": "input/capabilities"
    }, {
      "code": "path-resource",
      "value": "input/examples"
    }, {
      "code": "path-resource",
      "value": "input/extensions"
    }, {
      "code": "path-resource",
      "value": "input/models"
    }, {
      "code": "path-resource",
      "value": "input/operations"
    }, {
      "code": "path-resource",
      "value": "input/profiles"
    }, {
      "code": "path-resource",
      "value": "input/resources"
    }, {
      "code": "path-resource",
      "value": "input/vocabulary"
    }, {
      "code": "path-resource",
      "value": "input/maps"
    }, {
      "code": "path-resource",
      "value": "input/testing"
    }, {
      "code": "path-resource",
      "value": "input/history"
    }, {
      "code": "path-resource",
      "value": "fsh-generated/resources"
    }, {
      "code": "path-pages",
      "value": "template/config"
    }, {
      "code": "path-pages",
      "value": "input/images"
    }, {
      "code": "path-liquid",
      "value": "template/liquid"
    }, {
      "code": "path-liquid",
      "value": "input/liquid"
    }, {
      "code": "path-qa",
      "value": "temp/qa"
    }, {
      "code": "path-temp",
      "value": "temp/pages"
    }, {
      "code": "path-output",
      "value": "output"
    }, {
      "code": "path-tx-cache",
      "value": "input-cache/txcache"
    }, {
      "code": "path-suppressed-warnings",
      "value": "input/ignoreWarnings.txt"
    }, {
      "code": "template-html",
      "value": "template-page.html"
    }, {
      "code": "template-md",
      "value": "template-page-md.html"
    }, {
      "code": "apply-contact",
      "value": "true"
    }, {
      "code": "apply-context",
      "value": "true"
    }, {
      "code": "apply-copyright",
      "value": "true"
    }, {
      "code": "apply-jurisdiction",
      "value": "true"
    }, {
      "code": "apply-license",
      "value": "true"
    }, {
      "code": "apply-publisher",
      "value": "true"
    }, {
      "code": "apply-version",
      "value": "true"
    } ]
  },
  "date": "2021-08-13T13:26:56+00:00",
  "publisher": "HL7 International - Public Health Work Group",
  "fhirVersion": [ "4.0.1" ],
  "license": "Apache-2.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
    } ]
  } ],
  "dependsOn": [ {
    "id": "us_cdc_phinvads",
    "uri": "http://fhir.org/packages/us.cdc.phinvads/ImplementationGuide/us.cdc.phinvads",
    "version": "0.7.0",
    "packageId": "us.cdc.phinvads"
  }, {
    "id": "us_nlm_vsac",
    "uri": "http://fhir.org/packages/us.nlm.vsac/ImplementationGuide/us.nlm.vsac",
    "version": "0.4.0",
    "packageId": "us.nlm.vsac"
  } ],
  "name": "SMARTHealthCardsVaccinationAndTestingIG",
  "type": null,
  "experimental": null,
  "resourceType": "ImplementationGuide",
  "title": "SMART Health Cards: Vaccination & Testing Implementation Guide",
  "package_version": "0.6.2",
  "status": "draft",
  "id": "80ae5455-1eda-4a9d-8ee9-bcd4cbf8d5ff",
  "kind": null,
  "url": "http://hl7.org/fhir/uv/shc-vaccination/ImplementationGuide/hl7.fhir.uv.shc-vaccination",
  "version": "0.6.2",
  "packageId": "hl7.fhir.uv.shc-vaccination",
  "contact": [ {
    "name": "HL7 International - Public Health Work Group",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/pher",
      "system": "url"
    }, {
      "value": "vci-ig@mitre.org",
      "system": "email"
    } ]
  } ]
}