{ "resourceType": "StructureDefinition", "id": "us-core-immunization", "text": { "status": "generated", "div": "
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Immunization 0..*
\".\"\".\"\".\" status S1..1codeBinding: ImmunizationStatusCodes (required)
\".\"\".\"\".\" statusReason S0..1CodeableConceptBinding: ImmunizationStatusReasonCodes (example)
\".\"\".\"\".\" vaccineCode SI1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: US Core Vaccine Administered Value Set (CVX) (extensible)
us-core-1: SHOULD have a translation to the NDC value set
\".\"\".\"\".\" patient S1..1Reference(US Core Patient Profile)
\".\"\".\"\".\" occurrence[x] S1..1
\".\"\".\"\".\"\".\" occurrenceDateTimedateTime
\".\"\".\"\".\"\".\" occurrenceStringstring
\".\"\".\"\".\" primarySource S1..1boolean

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization", "version": "3.1.0", "name": "USCoreImmunizationProfile", "title": "US Core Immunization Profile", "status": "active", "experimental": false, "date": "2019-08-25T14:00:00+00:00", "publisher": "HL7 US Realm Steering Committee", "contact": [ { "telecom": [ { "system": "url", "value": "http://www.healthit.gov" } ] } ], "description": "Defines constraints and extensions on the Immunization resource for the minimal set of data to query and retrieve patient's immunization information.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US", "display": "United States of America" } ] } ], "fhirVersion": "4.0.1", "mapping": [ { "identity": "quick", "uri": "http://unknown.org/QUICK", "name": "QUICK" }, { "identity": "argonaut-dq-dstu2", "uri": "http://unknown.org/Argonaut-DQ-DSTU2", "name": "Argonaut-DQ-DSTU2" }, { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "cda", "uri": "http://hl7.org/v3/cda", "name": "CDA (R2)" } ], "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "snapshot": {}, "differential": { "element": [ { "id": "Immunization", "path": "Immunization", "definition": "The US Core Immunization Profile is based upon the core FHIR Immunization Resource and created to meet the 2015 Edition Common Clinical Data Set 'Immunizations' requirements.", "mustSupport": false, "mapping": [ { "identity": "quick", "map": "ImmunizationPerformanceOccurrence" }, { "identity": "quick", "map": "ImmunizationPerformanceOccurrence" }, { "identity": "argonaut-dq-dstu2", "map": "Immunization" } ] }, { "id": "Immunization.status", "path": "Immunization.status", "min": 1, "max": "1", "type": [ { "code": "code" } ], "mustSupport": true, "binding": { "strength": "required", "description": "Constrained list of immunizaiotn status", "valueSetUnknownType_StructureDefinition.differential.element[1].binding.valueSet": "http://hl7.org/fhir/ValueSet/immunization-status" }, "mapping": [ { "identity": "argonaut-dq-dstu2", "map": "Immunization.status" } ] }, { "id": "Immunization.statusReason", "path": "Immunization.statusReason", "min": 0, "max": "1", "mustSupport": true, "binding": { "strength": "example", "valueSetUnknownType_StructureDefinition.differential.element[2].binding.valueSet": "http://hl7.org/fhir/ValueSet/immunization-status-reason" }, "mapping": [ { "identity": "argonaut-dq-dstu2", "map": "Immunization.wasNotGiven" } ] }, { "id": "Immunization.vaccineCode", "path": "Immunization.vaccineCode", "short": "Vaccine Product Type (bind to CVX)", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "condition": [ "us-core-1" ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true } ], "key": "us-core-1", "severity": "warning", "human": "SHOULD have a translation to the NDC value set", "expression": "coding.where(system='http://hl7.org/fhir/sid/ndc').empty()", "xpath": "not(exists(f:coding/f:system[@value='http://hl7.org/fhir/sid/ndc']))" } ], "mustSupport": true, "binding": { "strength": "extensible", "description": "The CVX (vaccine administered) code system", "valueSetUnknownType_StructureDefinition.differential.element[3].binding.valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vaccines-cvx" }, "mapping": [ { "identity": "quick", "map": "vaccine" }, { "identity": "quick", "map": "vaccine" }, { "identity": "argonaut-dq-dstu2", "map": "Immunization.vaccineCode" } ] }, { "id": "Immunization.patient", "path": "Immunization.patient", "alias": [ "Patient" ], "min": 1, "max": "1", "type": [ { "targetProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ], "code": "Reference" } ], "mustSupport": true, "mapping": [ { "identity": "quick", "map": "subject" }, { "identity": "quick", "map": "subject" }, { "identity": "argonaut-dq-dstu2", "map": "Immunization.patient" } ] }, { "id": "Immunization.occurrence[x]", "path": "Immunization.occurrence[x]", "min": 1, "max": "1", "type": [ { "code": "dateTime" }, { "code": "string" } ], "mustSupport": true, "mapping": [ { "identity": "quick", "map": "performanceTime" }, { "identity": "quick", "map": "performanceTime" }, { "identity": "argonaut-dq-dstu2", "map": "Immunization.date" } ] }, { "id": "Immunization.primarySource", "path": "Immunization.primarySource", "min": 1, "max": "1", "type": [ { "code": "boolean" } ], "mustSupport": true, "mapping": [ { "identity": "quick", "map": "reported" }, { "identity": "quick", "map": "reported" }, { "identity": "argonaut-dq-dstu2", "map": "Immunization.reported" } ] } ] } }