diff --git a/knowledge/src/main/java/com/google/android/fhir/knowledge/KnowledgeManager.kt b/knowledge/src/main/java/com/google/android/fhir/knowledge/KnowledgeManager.kt
index 160061163c..e319fa79c9 100644
--- a/knowledge/src/main/java/com/google/android/fhir/knowledge/KnowledgeManager.kt
+++ b/knowledge/src/main/java/com/google/android/fhir/knowledge/KnowledgeManager.kt
@@ -96,7 +96,7 @@ internal constructor(
suspend fun install(fhirNpmPackage: FhirNpmPackage, rootDirectory: File) {
// TODO(ktarasenko) copy files to the safe space?
val igId = knowledgeDao.insert(fhirNpmPackage.toEntity(rootDirectory))
- rootDirectory.listFiles()?.forEach { file ->
+ rootDirectory.listFiles()?.sorted()?.forEach { file ->
try {
val resource = jsonParser.parseResource(FileInputStream(file))
if (resource is Resource) {
diff --git a/workflow/build.gradle.kts b/workflow/build.gradle.kts
index 0d3d6e9bc3..58ac122a95 100644
--- a/workflow/build.gradle.kts
+++ b/workflow/build.gradle.kts
@@ -107,6 +107,8 @@ dependencies {
testImplementation(Dependencies.jsonAssert)
testImplementation(Dependencies.robolectric)
testImplementation(Dependencies.xmlUnit)
+ testImplementation(libs.androidx.room.room)
+ testImplementation(libs.androidx.room.runtime)
testImplementation(libs.androidx.test.core)
testImplementation(libs.junit)
testImplementation(libs.truth)
diff --git a/workflow/sampledata/smart-imm/ig/ActivityDefinition-IMMZD2DTMeaslesMR.json b/workflow/sampledata/smart-imm/ig/ActivityDefinition-IMMZD2DTMeaslesMR.json
new file mode 100644
index 0000000000..6743b50595
--- /dev/null
+++ b/workflow/sampledata/smart-imm/ig/ActivityDefinition-IMMZD2DTMeaslesMR.json
@@ -0,0 +1,79 @@
+{
+ "resourceType" : "ActivityDefinition",
+ "id" : "IMMZD2DTMeaslesMR",
+ "meta" : {
+ "profile" : ["http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-immunizationactivity"]
+ },
+ "text" : {
+ "status" : "extensions",
+ "div" : "Generated Narrative: ActivityDefinition
CPG Knowledge Capability Extension: computable
url: http://fhir.org/guides/who/smart-immunization/ActivityDefinition/IMMZD2DTMeaslesMR
version: 0.1.0
name: IMMZD2DTMeaslesMR
title: IMMZ.D2.DT.Measles.MR
status: draft
experimental: false
date: 2023-10-03
publisher: World Health Organization (WHO)
contact: World Health Organization (WHO): https://www.who.int
description: Provide measles immunization
jurisdiction: Global (Whole world) (m49.htm#001)
library: IMMZD2DTMeasles
kind: MedicationRequest
profile: CPG Immunization Request
intent: proposal
doNotPerform: false
product: Measles vaccines (icd-11#XM28X5)
dynamicValue
path: status
Expressions
| - | Language | Expression |
| * | text/cql | 'draft' |
dynamicValue
path: intent
Expressions
| - | Language | Expression |
| * | text/cql | 'proposal' |
dynamicValue
path: dispenseRequest.validityPeriod.start
Expressions
| - | Description | Language | Expression |
| * | Due date of the dose | text/cql-identifier | Schedule Due Date for MCV dose |
dynamicValue
path: dispenseRequest.validityPeriod.end
Expressions
| - | Description | Language | Expression |
| * | Expiration date for MCV dose | text/cql-identifier | Expiration Date for MCV dose |
This case-insensitive code system http://fhir.org/guides/who/smart-immunization/CodeSystem/IMMZ.C defines the following codes:
| Code | Display | Definition |
| DE1 | Unique identifier | Unique identifier for the client, according to the policies applicable to each country. There can be more than one unique identifier used to link records (e.g. national ID, health ID, immunization information system ID, medical record ID). |
| DE2 | Name | The full name of the client |
| DE3 | First name | Client's first name or given name |
| DE4 | Family name | Client's family name or last name |
| DE5 | Sex | Documentation of a specific instance of sex information for the client |
| DE6 | Male | Client's biological sex is male |
| DE7 | Female | Client's biological sex is female |
| DE8 | Biological sex not specified | Client's biological sex is not specified |
| DE9 | Intersex | Client's biological sex is intersex |
| DE10 | Date of birth | Client's date of birth (DOB) if known; if unknown, use assigned DOB for administrative purposes |
| DE13 | Age | The client's calculated age (presented as number of years, months, days) based on the date of birth (DOB) and the visit date |
| DE14 | Caregivers (multiple) | The client's caregiver (person) which could be next of kin (e.g. partner, husband, mother, sibling, etc.) |
| DE15 | Caregiver's full name | The full name of the client's caregiver |
| DE16 | Caregiver's first name | First or given name of the client's caregiver |
| DE17 | Caregiver's family name | Family name or last name of the client's caregiver |
| DE18 | Contact phone number | Client's phone number |
| DE19 | Administrative area | The name of the city/municipality/town/village of where the client lives |
| DE20 | Active health worker | Is the client an active and participating health worker. This data element is used mainly for reporting and indicators purposes. |
This case-insensitive code system http://fhir.org/guides/who/smart-immunization/CodeSystem/IMMZ.D1 defines the following codes:
| Code | Display | Definition |
| DE80 | Dose 0 administered | Indicates if the client has received a birth dose and/or supplementary dose |
| DE8 | Completed the primary vaccination series | Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen. |
| DE81 | Date when primary vaccination series was completed | The date when the client completed the primary vaccination series (per product/antigen) |
| DE10 | HIV status | The current human immunodeficiency virus (HIV) status of the client |
| DE11 | HIV-positive | The client is known to be HIV positive |
| DE12 | HIV-negative | The client is known to be HIV negative |
| DE13 | Unknown | The client's HIV status is unknown |
| DE16 | Immunocompromised | The client is known to be immunocompromised or immunosuppressed. This means the client has a weakened immune system and having a reduced ability to fight infections and other diseases |
| DE17 | Currently on ART | The client is currently receiving antiretroviral therapy (ART) |
| DE84 | Type of TB infection test performed | The type of TB infection test performed |
| DE85 | IGRA | Interferon-gamma release assay (IGRA) |
| DE86 | TST | Tuberculin skin test (TST) |
| DE87 | TB infection test result | Records the result of the TB infection test |
| DE88 | Positive | Test result was positive |
| DE89 | Negative | Test result was negative |
| DE90 | HIV-exposed infant | The infant is known to be exposed to HIV (i.e. born to an HIV-infected woman) |
| DE29 | Birth weight in grams | Represents the client's birth weight value measures in grams |
| DE35 | Type of polio dose | The type of the polio vaccine dose administered to the client |
| DE36 | IPV | Inactivated poliovirus vaccine (IPV) |
| DE37 | bOPV | Bivalent oral poliovirus vaccine (bOPV) |
| DE38 | Age in years when client received first DTP dose | The client's age in years when they received their first diphtheria-tetanus-pertussis (DTP) dose |
| DE39 | Age in months when client received first Hib dose | The client's age in months when they received their first Haemophilus influenzae type b (Hib) dose |
| DE40 | Sickle-cell disease | The client is known to have a sickle-cell disease |
| DE41 | Age in months when client received third pneumococcal dose | The client's age in months when they received their third pneumococcal dose |
| DE42 | No history of intussusception | The client is known to have no history of intussusception |
| DE43 | Previous rotavirus doses given were the same product | Indicates whether or not all of the client's previous rotavirus doses were the same product |
| DE46 | Immune reconstitution was achieved | The client is known to have achieved immune reconstitution |
| DE92 | Severely immunosuppressed | The client is known to be severely immunocompromised or immunosuppressed |
| DE49 | ART start date | The date on which the client started or restarted antiretroviral therapy (ART) |
| DE52 | Type of last JE dose | The type of the last Japanese encephalitis (JE) vaccine dose administered to the client |
| DE53 | Inactivated Vero cell-derived vaccine | Inactivated Vero cell-derived Japanese encephalitis (JE) vaccine type |
| DE54 | Live attenuated vaccine | Live attenuated Japanese encephalitis (JE) vaccine type |
| DE55 | Live recombinant vaccine | Live recombinant Japanese encephalitis (JE) vaccine type |
| DE56 | Type of last TBE dose | The type of the last tick-borne encephalitis (TBE) vaccine dose administered |
| DE57 | FSME-Immun | FSME-Immun vaccine product, which is an inactivated whole-virus vaccine for tick-borne encephalitis (TBE) |
| DE58 | Encepur | Encepur vaccine product, which is an inactivated viral vaccine for tick-borne encephalitis (TBE) |
| DE59 | TBE-Moscow | TBE-Moscow vaccine product, which is a vaccine for tick-borne encephalitis (TBE) |
| DE60 | EnceVir | EnceVir vaccine product, which is a vaccine for tick-borne encephalitis (TBE) |
| DE61 | Type of last typhoid dose | The type of the last typhoid vaccine dose administered to the client |
| DE62 | Typbar-TCV | Typbar-TCV vaccine |
| DE63 | ViPS | Vi polysaccharide (ViPS) vaccine |
| DE64 | Ty21a | Ty21a vaccine |
| DE65 | Type of last cholera dose | The type of the last cholera vaccine dose administered to the client |
| DE66 | WC vaccine | Killed whole cell (WC) only cholera vaccine |
| DE67 | WC-rBS vaccine | Vaccine contains a mixture of the recombinant B subunit (rBS) of cholera toxin plus killed whole cell (WC) |
| DE68 | Type of last meningococcal dose | The type of the last meningococcal vaccine dose administered to the client |
| DE69 | MenA conjugate vaccine (5µg) | Monovalent serogroup A (MenA) conjugate vaccine (5µg) vaccine |
| DE70 | Monovalent MenC conjugate | Monovalent MenC conjugate vaccine |
| DE71 | Quadrivalent conjugate | Quadrivalent conjugate (A,C,W135,Y-D and A,C,W135,Y-CRM) vaccines |
| DE72 | Age in months when client received first meningococcal dose | The age in months when client received their first meningococcal dose |
| DE73 | Type of last hepatitis A dose | The type of the last hepatitis A vaccine dose administered to the client |
| DE74 | Live attenuated hepatitis A vaccine | Live attenuated hepatitis A vaccine |
| DE75 | Inactivated hepatitis A vaccine | Inactivated hepatitis A vaccine |
| DE76 | VNA level | Vaccine-induced neutralizing (VNA) antibody level. It is a measured as a serum antibody concentration amount observed from the result of the concentrated, purified cell culture and embryonated egg-based rabies vaccines (CCEEV) |
| DE77 | Seronegative for dengue | The client is known to be seronegative for dengue |
This case-insensitive code system http://fhir.org/guides/who/smart-immunization/CodeSystem/IMMZ.D4 defines the following codes:
| Code | Display | Definition |
| DE161 | Potential contraindications | Specific situations or medical conditions in which it is advised or recommended to avoid or delay administering a particular vaccine |
| DE162 | Currently pregnant | The client is currently pregnant |
| DE165 | Severely immunosuppressed | The client is known to be severely immunocompromised or immunosuppressed |
| DE166 | History of anaphylactic reactions | The client is known to have history of anaphylaxis in the past. Anaphylaxis is a severe and potentially life-threatening allergic reaction that can occur rapidly after exposure to an allergen or vaccine component. |
| DE167 | Severe allergic reactions | The client is known to have severe allergic reaction to vaccine |
| DE168 | Symptomatic HIV infection | The client is experiencing HIV-related symptoms |
This case-sensitive code system http://who.int/cg/CodeSystem/extended-content-codes defines the following codes:
| Code | Display | Definition |
| Returning Client | Returning client | Visit type - Returning client |
| Referral | Referral | Visit type - Referral |
| New Client | New client | Visit type - New client |
| First visit for symptoms | First visit for symptoms | Visit type - First visit for symptoms |
| STI Follow up | Follow up for STI management | Visit type - Follow up for STI management |
| Community | Community | Referred by - Community |
| Facility | Facility | Referred by - Facility |
| Levonorgestrel (LNG) two-rod implant | Levonorgestrel (LNG) two-rod implant | Method at intake - Levonorgestrel (LNG) two-rod implant |
| Other | Other | Reason for no contraceptive method - Reported at intake - Other |
| Other | Other | HIV Test Result - Other |
| Don't know | Don't know | Current medications - Don't know |
| STI medication | STI medication | Current medications - STI medication |
| Other Antibiotics | Other antibiotics | Current medications - Other antibiotics |
| Other | Other (specify) | Current medications - Other (specify) |
| Other | Other | Drug allergies - Other |
| PrEP status | PrEP status | PrEP status |
| Antiretroviral regimen (date and dose) | Antiretroviral regimen (date and dose) | Antiretroviral regimen (date and dose) |
| NONE | No education | Highest level of education achieved - No education |
| Other | Other (specify) | Occupation - Other (specify) |
| G | Government | Payment method - Government |
| I | Insurance | Payment method - Insurance |
Mapping from (not specified) to (not specified)
ACTIVE. Published on 2023-08-04 by World Health Organization (WHO) (World Health Organization (WHO): https://www.who.int).
Mapping to and from IMMZ.C Data Dictionary to other codesystems.
\n
Group 1Mapping from IMMZ.C CodeSystem for Data Elements to http://hl7.org/fhir/sid/icd-11
| Source Code | Relationship | Target Code |
| DE6 (Male) | | XX2UQ8 |
| DE7 (Female) | | XX2V25 |
| DE8 (Biological sex not specified) | | XX2PX3 |
| DE9 (Intersex) | | XX45B7 |
Group 2Mapping from http://hl7.org/fhir/sid/icd-11 to IMMZ.C CodeSystem for Data Elements
| Source Code | Relationship | Target Code |
| XX2UQ8 | | DE6 (Male) |
| XX2V25 | | DE7 (Female) |
| XX2PX3 | | DE8 (Biological sex not specified) |
| XX45B7 | | DE9 (Intersex) |
Group 3Mapping from IMMZ.C CodeSystem for Data Elements to Logical Observation Identifiers, Names and Codes (LOINC)
| Source Code | Relationship | Target Code |
| DE2 (Name) | | 54125-0 |
| DE3 (First name) | | 45392-8 |
| DE4 (Family name) | | 45394-4 |
| DE5 (Sex) | | 46098-0 |
| DE10 (Date of birth) | | 21112-8 |
| DE13 (Age) | | 63900-5 |
| DE18 (Contact phone number) | | 42077-8 |
| DE19 (Administrative area) | | 56799-0 |
Group 4Mapping from IMMZ.C CodeSystem for Data Elements to SNOMED CT (all versions)
| Source Code | Relationship | Target Code |
| DE2 (Name) | | 371484003 |
| DE3 (First name) | | 184095009 |
| DE4 (Family name) | | 184096005 |
| DE5 (Sex) | | 184100006 |
| DE6 (Male) | | 248153007 |
| DE7 (Female) | | 248152002 |
| DE8 (Biological sex not specified) | | 772004004 |
| DE9 (Intersex) | | 15867007 |
| DE10 (Date of birth) | | 184099003 |
| DE14 (Caregivers (multiple)) | | 184140000 |
| DE15 (Caregiver's full name) | | 184140000 |
| DE18 (Contact phone number) | | 184103008 |
| DE19 (Administrative area) | | 184097001 |
Group 5Mapping from SNOMED CT (all versions) to IMMZ.C CodeSystem for Data Elements
| Source Code | Relationship | Target Code |
| 248153007 | | DE6 (Male) |
| 248152002 | | DE7 (Female) |
| 772004004 | | DE8 (Biological sex not specified) |
| 15867007 | | DE9 (Intersex) |
Mapping from (not specified) to (not specified)
ACTIVE. Published on 2023-08-09 by World Health Organization (WHO) (World Health Organization (WHO): https://www.who.int).
Mapping to and from IMMZ.C sex coding to FHIR Administrative Gender.
\n
Group 1Mapping from IMMZ.C CodeSystem for Data Elements to AdministrativeGender
| Source Code | Relationship | Target Code |
| DE6 (Male) | | male |
| DE7 (Female) | | female |
| DE8 (Biological sex not specified) | | unknown |
| DE9 (Intersex) | | other |
Group 2Mapping from AdministrativeGender to IMMZ.C CodeSystem for Data Elements
| Source Code | Relationship | Target Code |
| male | | DE6 (Male) |
| female | | DE7 (Female) |
| unknown | | DE8 (Biological sex not specified) |
| other | | DE9 (Intersex) |
Mapping from (not specified) to (not specified)
ACTIVE. Published on 2023-08-09 by World Health Organization (WHO) (World Health Organization (WHO): https://www.who.int).
Mapping to and from IMMZ.D1 Data Dictionary to other codesystems.
\n
Group 1Mapping from IMMZ.D1 CodeSystem for Data Elements to http://hl7.org/fhir/sid/icd-11
| Source Code | Relationship | Target Code |
| DE88 (Positive) | | 1B1Z |
| DE11 (HIV-positive) | | 1C62.Z |
| DE13 (Unknown) | | 1H0Z |
| DE40 (Sickle-cell disease) | | 3A51 |
| DE16 (Immunocompromised) | | 4B4Z |
| DE89 (Negative) | | QA02.0 |
| DE12 (HIV-negative) | | QA02.Y |
| DE90 (HIV-exposed infant) | | QC60 |
| DE70 (Monovalent MenC conjugate) | | XM18Y8 |
| DE69 (MenA conjugate vaccine (5µg)) | | XM2280 |
| DE64 (Ty21a) | | XM33K4 |
| DE85 (IGRA) | | XM3KQ4 |
| DE63 (ViPS) | | XM3SF6 |
| DE54 (Live attenuated vaccine) | | XM47S0 |
| DE36 (IPV) | | XM5V19 |
| DE37 (bOPV) | | XM79H3 |
| DE86 (TST) | | XM7PF6 |
Group 2Mapping from http://hl7.org/fhir/sid/icd-11 to IMMZ.D1 CodeSystem for Data Elements
| Source Code | Relationship | Target Code |
| 1B1Z | | DE88 (Positive) |
| 1C62.Z | | DE11 (HIV-positive) |
| 1H0Z | | DE13 (Unknown) |
| 3A51 | | DE40 (Sickle-cell disease) |
| 4B4Z | | DE16 (Immunocompromised) |
| QA02.0 | | DE89 (Negative) |
| QA02.Y | | DE12 (HIV-negative) |
| QC60 | | DE90 (HIV-exposed infant) |
| XM18Y8 | | DE70 (Monovalent MenC conjugate) |
| XM2280 | | DE69 (MenA conjugate vaccine (5µg)) |
| XM33K4 | | DE64 (Ty21a) |
| XM3KQ4 | | DE85 (IGRA) |
| XM3SF6 | | DE63 (ViPS) |
| XM47S0 | | DE54 (Live attenuated vaccine) |
| XM5V19 | | DE36 (IPV) |
| XM79H3 | | DE37 (bOPV) |
| XM7PF6 | | DE86 (TST) |
Group 3Mapping from IMMZ.D1 CodeSystem for Data Elements to Logical Observation Identifiers, Names and Codes (LOINC)
| Source Code | Relationship | Target Code |
| DE90 (HIV-exposed infant) | | 10157-6 |
| DE85 (IGRA) | | 27415-9 |
| DE86 (TST) | | 39263-9 |
| DE88 (Positive) | | 45241-7 |
| DE11 (HIV-positive) | | 45683-0 |
| DE10 (HIV status) | | 55277-8 |
| DE29 (Birth weight in grams) | | 8339-4 |
| DE16 (Immunocompromised) | | 96381-9 |
| DE92 (Severely immunosuppressed) | | 96381-9 |
Group 4Mapping from Logical Observation Identifiers, Names and Codes (LOINC) to IMMZ.D1 CodeSystem for Data Elements
| Source Code | Relationship | Target Code |
| 10157-6 | | DE90 (HIV-exposed infant) |
| 27415-9 | | DE85 (IGRA) |
| 39263-9 | | DE86 (TST) |
| 45241-7 | | DE88 (Positive) |
| 45683-0 | | DE11 (HIV-positive) |
| 55277-8 | | DE10 (HIV status) |
| 8339-4 | | DE29 (Birth weight in grams) |
| 96381-9 | | DE16 (Immunocompromised) |
| 96381-9 | | DE92 (Severely immunosuppressed) |
Group 5Mapping from IMMZ.D1 CodeSystem for Data Elements to SNOMED CT (all versions)
| Source Code | Relationship | Target Code |
| DE88 (Positive) | | 10828004 |
| DE86 (TST) | | 28163009 |
| DE85 (IGRA) | | 68311008 |
| DE12 (HIV-negative) | | 165815009 |
| DE11 (HIV-positive) | | 165816005 |
| DE89 (Negative) | | 260385009 |
| DE13 (Unknown) | | 261665006 |
| DE10 (HIV status) | | 278977008 |
| DE16 (Immunocompromised) | | 370388006 |
| DE40 (Sickle-cell disease) | | 417357006 |
| DE90 (HIV-exposed infant) | | 438998000 |
| DE36 (IPV) | | 871740006 |
Group 6Mapping from SNOMED CT (all versions) to IMMZ.D1 CodeSystem for Data Elements
| Source Code | Relationship | Target Code |
| 10828004 | | DE88 (Positive) |
| 28163009 | | DE86 (TST) |
| 68311008 | | DE85 (IGRA) |
| 165815009 | | DE12 (HIV-negative) |
| 165816005 | | DE11 (HIV-positive) |
| 260385009 | | DE89 (Negative) |
| 261665006 | | DE13 (Unknown) |
| 278977008 | | DE10 (HIV status) |
| 370388006 | | DE16 (Immunocompromised) |
| 417357006 | | DE40 (Sickle-cell disease) |
| 438998000 | | DE90 (HIV-exposed infant) |
| 871740006 | | DE36 (IPV) |
Generated Narrative: Device
manufacturer: CQFramework
DeviceNames
| - | Name | Type |
| * | cqf-tooling | manufacturer-name |
type: Tooling (Software System Type Codes#tooling)
Versions
Immunization
The official URL for this implementation guide is:
http://fhir.org/guides/who/smart-immunization/ImplementationGuide/fhir.who.immunization
WHO Immunization Implementation Guide.
\n
Related Artifacts
Parameters
Data Requirements
Contents
text/cql
/*\n@author: Bryn Rhodes\n@description: Common terminologies and functions used in FHIR-based CQL artifacts\n*/\nlibrary FHIRCommon version '4.0.1'\n\nusing FHIR version '4.0.1'\n\ninclude FHIRHelpers version '4.0.1'\n\ncodesystem "LOINC": 'http://loinc.org'\ncodesystem "SNOMEDCT": 'http://snomed.info/sct'\ncodesystem "RoleCode": 'http://terminology.hl7.org/CodeSystem/v3-RoleCode'\ncodesystem "Diagnosis Role": 'http://terminology.hl7.org/CodeSystem/diagnosis-role'\ncodesystem "RequestIntent": 'http://terminology.hl7.org/CodeSystem/request-intent'\ncodesystem "MedicationRequestCategory": 'http://terminology.hl7.org/CodeSystem/medicationrequest-category'\ncodesystem "ConditionClinicalStatusCodes": 'http://terminology.hl7.org/CodeSystem/condition-clinical'\ncodesystem "ConditionVerificationStatusCodes": 'http://terminology.hl7.org/CodeSystem/condition-ver-status'\ncodesystem "AllergyIntoleranceClinicalStatusCodes": 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical'\ncodesystem "AllergyIntoleranceVerificationStatusCodes": 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification'\n\n// For \nvalueset "Active Condition": 'http://fhir.org/guides/cqf/common/ValueSet/active-condition'\nvalueset "Inactive Condition": 'http://fhir.org/guides/cqf/common/ValueSet/inactive-condition'\n\ncode "Birthdate": '21112-8' from "LOINC" display 'Birth date'\ncode "Dead": '419099009' from "SNOMEDCT" display 'Dead'\ncode "ER": 'ER' from "RoleCode" display 'Emergency room'\ncode "ICU": 'ICU' from "RoleCode" display 'Intensive care unit'\ncode "Billing": 'billing' from "Diagnosis Role" display 'Billing'\n\n// Condition Clinical Status Codes - Consider value sets for these\ncode "active": 'active' from "ConditionClinicalStatusCodes"\ncode "recurrence": 'recurrence' from "ConditionClinicalStatusCodes"\ncode "relapse": 'relapse' from "ConditionClinicalStatusCodes"\ncode "inactive": 'inactive' from "ConditionClinicalStatusCodes"\ncode "remission": 'remission' from "ConditionClinicalStatusCodes"\ncode "resolved": 'resolved' from "ConditionClinicalStatusCodes"\n\n// Condition Verification Status Codes - Consider value sets for these\ncode "unconfirmed": 'unconfirmed' from ConditionVerificationStatusCodes\ncode "provisional": 'provisional' from ConditionVerificationStatusCodes\ncode "differential": 'differential' from ConditionVerificationStatusCodes\ncode "confirmed": 'confirmed' from ConditionVerificationStatusCodes\ncode "refuted": 'refuted' from ConditionVerificationStatusCodes\ncode "entered-in-error": 'entered-in-error' from ConditionVerificationStatusCodes\n\ncode "allergy-active": 'active' from "AllergyIntoleranceClinicalStatusCodes"\ncode "allergy-inactive": 'inactive' from "AllergyIntoleranceClinicalStatusCodes"\ncode "allergy-resolved": 'resolved' from "AllergyIntoleranceClinicalStatusCodes"\n\n// Allergy/Intolerance Verification Status Codes - Consider value sets for these\ncode "allergy-unconfirmed": 'unconfirmed' from AllergyIntoleranceVerificationStatusCodes\ncode "allergy-confirmed": 'confirmed' from AllergyIntoleranceVerificationStatusCodes\ncode "allergy-refuted": 'refuted' from AllergyIntoleranceVerificationStatusCodes\n\n// MedicationRequest Category Codes\ncode "Community": 'community' from "MedicationRequestCategory" display 'Community'\ncode "Discharge": 'discharge' from "MedicationRequestCategory" display 'Discharge'\n\n// Diagnosis Role Codes\ncode "AD": 'AD' from "Diagnosis Role" display 'Admission diagnosis'\ncode "DD": 'DD' from "Diagnosis Role" display 'Discharge diagnosis'\ncode "CC": 'CC' from "Diagnosis Role" display 'Chief complaint'\ncode "CM": 'CM' from "Diagnosis Role" display 'Comorbidity diagnosis'\ncode "pre-op": 'pre-op' from "Diagnosis Role" display 'pre-op diagnosis'\ncode "post-op": 'post-op' from "Diagnosis Role" display 'post-op diagnosis'\ncode "billing": 'billing' from "Diagnosis Role" display 'billing diagnosis'\n\ncontext Patient\n\n/*\n@description: Normalizes a value that is a choice of timing-valued types to an equivalent interval\n@comment: Normalizes a choice type of FHIR.dateTime, FHIR.Period, FHIR.Timing, FHIR.instance, FHIR.string, FHIR.Age, or FHIR.Range types\nto an equivalent interval. This selection of choice types is a superset of the majority of choice types that are used as possible\nrepresentations for timing-valued elements in FHIR, allowing this function to be used across any resource. NOTE: Due to the\ncomplexity of determining a single interval from a Timing or String type, this function will throw a run-time exception if it is used\nwith a Timing or String.\n*/\ndefine function ToInterval(choice Choice<FHIR.dateTime, FHIR.Period, FHIR.Timing, FHIR.instant, FHIR.string, FHIR.Age, FHIR.Range>):\n case\n\t when choice is FHIR.dateTime then\n \tInterval[FHIRHelpers.ToDateTime(choice as FHIR.dateTime), FHIRHelpers.ToDateTime(choice as FHIR.dateTime)]\n\t\twhen choice is FHIR.Period then\n \t\tFHIRHelpers.ToInterval(choice as FHIR.Period)\n\t\twhen choice is FHIR.instant then\n\t\t\tInterval[FHIRHelpers.ToDateTime(choice as FHIR.instant), FHIRHelpers.ToDateTime(choice as FHIR.instant)]\n\t\twhen choice is FHIR.Age then\n\t\t Interval[FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity(choice as FHIR.Age),\n\t\t\t FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity(choice as FHIR.Age) + 1 year)\n\t\twhen choice is FHIR.Range then\n\t\t Interval[FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity((choice as FHIR.Range).low),\n\t\t\t FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity((choice as FHIR.Range).high) + 1 year)\n\t\twhen choice is FHIR.Timing then\n\t\t Message(null as Interval<DateTime>, true, '1', 'Error', 'Cannot compute a single interval from a Timing type')\n when choice is FHIR.string then\n Message(null as Interval<DateTime>, true, '1', 'Error', 'Cannot compute an interval from a String value')\n\t\telse\n\t\t\tnull as Interval<DateTime>\n\tend\n\n/*\n@description: Returns an interval representing the normalized Abatement of a given Condition resource.\n@comment: NOTE: Due to the complexity of determining an interval from a String, this function will throw\na run-time exception if used with a Condition instance that has a String as the abatement value.\n*/\ndefine function ToAbatementInterval(condition Condition):\n\tif condition.abatement is FHIR.dateTime then\n\t Interval[FHIRHelpers.ToDateTime(condition.abatement as FHIR.dateTime), FHIRHelpers.ToDateTime(condition.abatement as FHIR.dateTime)]\n\telse if condition.abatement is FHIR.Period then\n\t FHIRHelpers.ToInterval(condition.abatement as FHIR.Period)\n\telse if condition.abatement is FHIR.string then\n Message(null as Interval<DateTime>, true, '1', 'Error', 'Cannot compute an interval from a String value')\n\telse if condition.abatement is FHIR.Age then\n\t\tInterval[FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity(condition.abatement as FHIR.Age),\n\t\t\tFHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity(condition.abatement as FHIR.Age) + 1 year)\n\telse if condition.abatement is FHIR.Range then\n\t Interval[FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity((condition.abatement as FHIR.Range).low),\n\t\t FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity((condition.abatement as FHIR.Range).high) + 1 year)\n\telse if condition.abatement is FHIR.boolean then\n\t Interval[end of ToInterval(condition.onset), condition.recordedDate)\n\telse null\n\n/*\n@description: Returns an interval representing the normalized prevalence period of a given Condition resource.\n@comment: Uses the ToInterval and ToAbatementInterval functions to determine the widest potential interval from\nonset to abatement as specified in the given Condition.\n*/\ndefine function ToPrevalenceInterval(condition Condition):\nif condition.clinicalStatus ~ "active"\n or condition.clinicalStatus ~ "recurrence"\n or condition.clinicalStatus ~ "relapse" then\n Interval[start of ToInterval(condition.onset), end of ToAbatementInterval(condition)]\nelse\n Interval[start of ToInterval(condition.onset), end of ToAbatementInterval(condition))\n\n/*\n@description: Returns any extensions defined on the given resource with the specified url.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the\nCQL model info.\n*/\ndefine function Extensions(domainResource DomainResource, url String):\n domainResource.extension E\n\t where E.url = url\n\t\treturn E\n\n/*\n@description: Returns the single extension (if present) on the given resource with the specified url.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function Extension(domainResource DomainResource, url String):\n singleton from "Extensions"(domainResource, url)\n\n/*\n@description: Returns any extensions defined on the given element with the specified url.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the CQL model info.\n*/\ndefine function Extensions(element Element, url String):\n element.extension E\n\t where E.url = url\n\t\treturn E\n\n/*\n@description: Returns the single extension (if present) on the given element with the specified url.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function Extension(element Element, url String):\n singleton from Extensions(element, url)\n\n/*\n@description: Returns any modifier extensions defined on the given resource with the specified url.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the\nCQL model info.\n*/\ndefine function ModifierExtensions(domainResource DomainResource, url String):\n domainResource.modifierExtension E\n\t where E.url = url\n\t\treturn E\n\n/*\n@description: Returns the single modifier extension (if present) on the given resource with the specified url.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function ModifierExtension(domainResource DomainResource, url String):\n singleton from ModifierExtensions(domainResource, url)\n\n/*\n@description: Returns any modifier extensions defined on the given element with the specified url.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the CQL model info.\n*/\ndefine function ModifierExtensions(element BackboneElement, url String):\n element.modifierExtension E\n\t where E.url = url\n\t\treturn E\n\n/*\n@description: Returns the single modifier extension (if present) on the given element with the specified url.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function ModifierExtension(element BackboneElement, url String):\n singleton from ModifierExtensions(element, url)\n\n/*\n@description: Returns any base-FHIR extensions defined on the given resource with the specified id.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the CQL model info.\n*/\ndefine function BaseExtensions(domainResource DomainResource, id String):\n domainResource.extension E\n\t where E.url = ('http://hl7.org/fhir/StructureDefinition/' + id)\n\t\treturn E\n\n/*\n@description: Returns the single base-FHIR extension (if present) on the given resource with the specified id.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function BaseExtension(domainResource DomainResource, id String):\n singleton from BaseExtensions(domainResource, id)\n\n/*\n@description: Returns any base-FHIR extensions defined on the given element with the specified id.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the CQL model info.\n*/\ndefine function BaseExtensions(element Element, id String):\n element.extension E\n\t where E.url = ('http://hl7.org/fhir/StructureDefinition/' + id)\n\t\treturn E\n\n/*\n@description: Returns the single base-FHIR extension (if present) on the given element with the specified id.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function BaseExtension(element Element, id String):\n singleton from BaseExtensions(element, id)\n\n/*\n@description: Returns any base-FHIR modifier extensions defined on the given resource with the specified id.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the CQL model info.\n*/\ndefine function BaseModifierExtensions(domainResource DomainResource, id String):\n domainResource.modifierExtension E\n\t where E.url = ('http://hl7.org/fhir/StructureDefinition/' + id)\n\t\treturn E\n\n/*\n@description: Returns the single base-FHIR modifier extension (if present) on the given resource with the specified id.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function BaseModifierExtension(domainResource DomainResource, id String):\n singleton from BaseModifierExtensions(domainResource, id)\n\n/*\n@description: Returns any base-FHIR modifier extensions defined on the given element with the specified id.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the CQL model info.\n*/\ndefine function BaseModifierExtensions(element BackboneElement, id String):\n element.modifierExtension E\n\t where E.url = ('http://hl7.org/fhir/StructureDefinition/' + id)\n\t\treturn E\n\n/*\n@description: Returns the single base-FHIR extension (if present) on the given element with the specified id.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function BaseModifierExtension(element BackboneElement, id String):\n singleton from BaseModifierExtensions(element, id)\n
Content not shown - (application/elm+xml, size = 202Kb)
Content not shown - (application/elm+json, size = 388Kb)
Related Artifacts
| depends-on | FHIR model information | http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 |
Contents
text/cql
/*\n@author: Bryn Rhodes\n@description: This library defines functions to convert between FHIR\n data types and CQL system-defined types, as well as functions to support\n FHIRPath implementation. For more information, see the FHIRHelpers wiki page:\n https://github.com/cqframework/clinical_quality_language/wiki/FHIRHelpers\n@allowFluent: true\n*/\nlibrary FHIRHelpers version '4.0.1'\n\nusing FHIR version '4.0.1'\n\ndefine function ToInterval(period FHIR.Period):\n if period is null then\n null\n else\n if period."start" is null then\n Interval(period."start".value, period."end".value]\n else\n Interval[period."start".value, period."end".value]\n\ndefine function ToCalendarUnit(unit System.String):\n case unit\n when 'ms' then 'millisecond'\n when 's' then 'second'\n when 'min' then 'minute'\n when 'h' then 'hour'\n when 'd' then 'day'\n when 'wk' then 'week'\n when 'mo' then 'month'\n when 'a' then 'year'\n else unit\n end\n\ndefine function ToQuantity(quantity FHIR.Quantity):\n case\n when quantity is null then null\n when quantity.value is null then null\n when quantity.comparator is not null then\n Message(null, true, 'FHIRHelpers.ToQuantity.ComparatorQuantityNotSupported', 'Error', 'FHIR Quantity value has a comparator and cannot be converted to a System.Quantity value.')\n when quantity.system is null or quantity.system.value = 'http://unitsofmeasure.org'\n or quantity.system.value = 'http://hl7.org/fhirpath/CodeSystem/calendar-units' then\n System.Quantity { value: quantity.value.value, unit: ToCalendarUnit(Coalesce(quantity.code.value, quantity.unit.value, '1')) }\n else\n Message(null, true, 'FHIRHelpers.ToQuantity.InvalidFHIRQuantity', 'Error', 'Invalid FHIR Quantity code: ' & quantity.unit.value & ' (' & quantity.system.value & '|' & quantity.code.value & ')')\n end\n\ndefine function ToQuantityIgnoringComparator(quantity FHIR.Quantity):\n case\n when quantity is null then null\n when quantity.value is null then null\n when quantity.system is null or quantity.system.value = 'http://unitsofmeasure.org'\n or quantity.system.value = 'http://hl7.org/fhirpath/CodeSystem/calendar-units' then\n System.Quantity { value: quantity.value.value, unit: ToCalendarUnit(Coalesce(quantity.code.value, quantity.unit.value, '1')) }\n else\n Message(null, true, 'FHIRHelpers.ToQuantity.InvalidFHIRQuantity', 'Error', 'Invalid FHIR Quantity code: ' & quantity.unit.value & ' (' & quantity.system.value & '|' & quantity.code.value & ')')\n end\n\ndefine function ToInterval(quantity FHIR.Quantity):\n if quantity is null then null else\n case quantity.comparator.value\n when '<' then\n Interval[\n null,\n ToQuantityIgnoringComparator(quantity)\n )\n when '<=' then\n Interval[\n null,\n ToQuantityIgnoringComparator(quantity)\n ]\n when '>=' then\n Interval[\n ToQuantityIgnoringComparator(quantity),\n null\n ]\n when '>' then\n Interval(\n ToQuantityIgnoringComparator(quantity),\n null\n ]\n else\n Interval[ToQuantity(quantity), ToQuantity(quantity)]\n end\n\ndefine function ToRatio(ratio FHIR.Ratio):\n if ratio is null then\n null\n else\n System.Ratio { numerator: ToQuantity(ratio.numerator), denominator: ToQuantity(ratio.denominator) }\n\ndefine function ToInterval(range FHIR.Range):\n if range is null then\n null\n else\n Interval[ToQuantity(range.low), ToQuantity(range.high)]\n\ndefine function ToCode(coding FHIR.Coding):\n if coding is null then\n null\n else\n System.Code {\n code: coding.code.value,\n system: coding.system.value,\n version: coding.version.value,\n display: coding.display.value\n }\n\ndefine function ToConcept(concept FHIR.CodeableConcept):\n if concept is null then\n null\n else\n System.Concept {\n codes: concept.coding C return ToCode(C),\n display: concept.text.value\n }\n\ndefine function reference(reference String):\n if reference is null then\n null\n else\n Reference { reference: string { value: reference } }\n\ndefine function resolve(reference String) returns Resource: external\ndefine function resolve(reference Reference) returns Resource: external\ndefine function reference(resource Resource) returns Reference: external\ndefine function extension(element Element, url String) returns List<Element>: external\ndefine function extension(resource Resource, url String) returns List<Element>: external\ndefine function hasValue(element Element) returns Boolean: external\ndefine function getValue(element Element) returns Any: external\ndefine function ofType(identifier String) returns List<Any>: external\ndefine function is(identifier String) returns Boolean: external\ndefine function as(identifier String) returns Any: external\ndefine function elementDefinition(element Element) returns ElementDefinition: external\ndefine function slice(element Element, url String, name String) returns List<Element>: external\ndefine function checkModifiers(resource Resource) returns Resource: external\ndefine function checkModifiers(resource Resource, modifier String) returns Resource: external\ndefine function checkModifiers(element Element) returns Element: external\ndefine function checkModifiers(element Element, modifier String) returns Element: external\ndefine function conformsTo(resource Resource, structure String) returns Boolean: external\ndefine function memberOf(code code, valueSet String) returns Boolean: external\ndefine function memberOf(coding Coding, valueSet String) returns Boolean: external\ndefine function memberOf(concept CodeableConcept, valueSet String) returns Boolean: external\ndefine function subsumes(coding Coding, subsumedCoding Coding) returns Boolean: external\ndefine function subsumes(concept CodeableConcept, subsumedConcept CodeableConcept) returns Boolean: external\ndefine function subsumedBy(coding Coding, subsumingCoding Coding) returns Boolean: external\ndefine function subsumedBy(concept CodeableConcept, subsumingConcept CodeableConcept) returns Boolean: external\ndefine function htmlChecks(element Element) returns Boolean: external\n\ndefine function ToString(value AccountStatus): value.value\ndefine function ToString(value ActionCardinalityBehavior): value.value\ndefine function ToString(value ActionConditionKind): value.value\ndefine function ToString(value ActionGroupingBehavior): value.value\ndefine function ToString(value ActionParticipantType): value.value\ndefine function ToString(value ActionPrecheckBehavior): value.value\ndefine function ToString(value ActionRelationshipType): value.value\ndefine function ToString(value ActionRequiredBehavior): value.value\ndefine function ToString(value ActionSelectionBehavior): value.value\ndefine function ToString(value ActivityDefinitionKind): value.value\ndefine function ToString(value ActivityParticipantType): value.value\ndefine function ToString(value AddressType): value.value\ndefine function ToString(value AddressUse): value.value\ndefine function ToString(value AdministrativeGender): value.value\ndefine function ToString(value AdverseEventActuality): value.value\ndefine function ToString(value AggregationMode): value.value\ndefine function ToString(value AllergyIntoleranceCategory): value.value\ndefine function ToString(value AllergyIntoleranceCriticality): value.value\ndefine function ToString(value AllergyIntoleranceSeverity): value.value\ndefine function ToString(value AllergyIntoleranceType): value.value\ndefine function ToString(value AppointmentStatus): value.value\ndefine function ToString(value AssertionDirectionType): value.value\ndefine function ToString(value AssertionOperatorType): value.value\ndefine function ToString(value AssertionResponseTypes): value.value\ndefine function ToString(value AuditEventAction): value.value\ndefine function ToString(value AuditEventAgentNetworkType): value.value\ndefine function ToString(value AuditEventOutcome): value.value\ndefine function ToString(value BindingStrength): value.value\ndefine function ToString(value BiologicallyDerivedProductCategory): value.value\ndefine function ToString(value BiologicallyDerivedProductStatus): value.value\ndefine function ToString(value BiologicallyDerivedProductStorageScale): value.value\ndefine function ToString(value BundleType): value.value\ndefine function ToString(value CapabilityStatementKind): value.value\ndefine function ToString(value CarePlanActivityKind): value.value\ndefine function ToString(value CarePlanActivityStatus): value.value\ndefine function ToString(value CarePlanIntent): value.value\ndefine function ToString(value CarePlanStatus): value.value\ndefine function ToString(value CareTeamStatus): value.value\ndefine function ToString(value CatalogEntryRelationType): value.value\ndefine function ToString(value ChargeItemDefinitionPriceComponentType): value.value\ndefine function ToString(value ChargeItemStatus): value.value\ndefine function ToString(value ClaimResponseStatus): value.value\ndefine function ToString(value ClaimStatus): value.value\ndefine function ToString(value ClinicalImpressionStatus): value.value\ndefine function ToString(value CodeSearchSupport): value.value\ndefine function ToString(value CodeSystemContentMode): value.value\ndefine function ToString(value CodeSystemHierarchyMeaning): value.value\ndefine function ToString(value CommunicationPriority): value.value\ndefine function ToString(value CommunicationRequestStatus): value.value\ndefine function ToString(value CommunicationStatus): value.value\ndefine function ToString(value CompartmentCode): value.value\ndefine function ToString(value CompartmentType): value.value\ndefine function ToString(value CompositionAttestationMode): value.value\ndefine function ToString(value CompositionStatus): value.value\ndefine function ToString(value ConceptMapEquivalence): value.value\ndefine function ToString(value ConceptMapGroupUnmappedMode): value.value\ndefine function ToString(value ConditionalDeleteStatus): value.value\ndefine function ToString(value ConditionalReadStatus): value.value\ndefine function ToString(value ConsentDataMeaning): value.value\ndefine function ToString(value ConsentProvisionType): value.value\ndefine function ToString(value ConsentState): value.value\ndefine function ToString(value ConstraintSeverity): value.value\ndefine function ToString(value ContactPointSystem): value.value\ndefine function ToString(value ContactPointUse): value.value\ndefine function ToString(value ContractPublicationStatus): value.value\ndefine function ToString(value ContractStatus): value.value\ndefine function ToString(value ContributorType): value.value\ndefine function ToString(value CoverageStatus): value.value\ndefine function ToString(value CurrencyCode): value.value\ndefine function ToString(value DayOfWeek): value.value\ndefine function ToString(value DaysOfWeek): value.value\ndefine function ToString(value DetectedIssueSeverity): value.value\ndefine function ToString(value DetectedIssueStatus): value.value\ndefine function ToString(value DeviceMetricCalibrationState): value.value\ndefine function ToString(value DeviceMetricCalibrationType): value.value\ndefine function ToString(value DeviceMetricCategory): value.value\ndefine function ToString(value DeviceMetricColor): value.value\ndefine function ToString(value DeviceMetricOperationalStatus): value.value\ndefine function ToString(value DeviceNameType): value.value\ndefine function ToString(value DeviceRequestStatus): value.value\ndefine function ToString(value DeviceUseStatementStatus): value.value\ndefine function ToString(value DiagnosticReportStatus): value.value\ndefine function ToString(value DiscriminatorType): value.value\ndefine function ToString(value DocumentConfidentiality): value.value\ndefine function ToString(value DocumentMode): value.value\ndefine function ToString(value DocumentReferenceStatus): value.value\ndefine function ToString(value DocumentRelationshipType): value.value\ndefine function ToString(value EligibilityRequestPurpose): value.value\ndefine function ToString(value EligibilityRequestStatus): value.value\ndefine function ToString(value EligibilityResponsePurpose): value.value\ndefine function ToString(value EligibilityResponseStatus): value.value\ndefine function ToString(value EnableWhenBehavior): value.value\ndefine function ToString(value EncounterLocationStatus): value.value\ndefine function ToString(value EncounterStatus): value.value\ndefine function ToString(value EndpointStatus): value.value\ndefine function ToString(value EnrollmentRequestStatus): value.value\ndefine function ToString(value EnrollmentResponseStatus): value.value\ndefine function ToString(value EpisodeOfCareStatus): value.value\ndefine function ToString(value EventCapabilityMode): value.value\ndefine function ToString(value EventTiming): value.value\ndefine function ToString(value EvidenceVariableType): value.value\ndefine function ToString(value ExampleScenarioActorType): value.value\ndefine function ToString(value ExplanationOfBenefitStatus): value.value\ndefine function ToString(value ExposureState): value.value\ndefine function ToString(value ExtensionContextType): value.value\ndefine function ToString(value FHIRAllTypes): value.value\ndefine function ToString(value FHIRDefinedType): value.value\ndefine function ToString(value FHIRDeviceStatus): value.value\ndefine function ToString(value FHIRResourceType): value.value\ndefine function ToString(value FHIRSubstanceStatus): value.value\ndefine function ToString(value FHIRVersion): value.value\ndefine function ToString(value FamilyHistoryStatus): value.value\ndefine function ToString(value FilterOperator): value.value\ndefine function ToString(value FlagStatus): value.value\ndefine function ToString(value GoalLifecycleStatus): value.value\ndefine function ToString(value GraphCompartmentRule): value.value\ndefine function ToString(value GraphCompartmentUse): value.value\ndefine function ToString(value GroupMeasure): value.value\ndefine function ToString(value GroupType): value.value\ndefine function ToString(value GuidanceResponseStatus): value.value\ndefine function ToString(value GuidePageGeneration): value.value\ndefine function ToString(value GuideParameterCode): value.value\ndefine function ToString(value HTTPVerb): value.value\ndefine function ToString(value IdentifierUse): value.value\ndefine function ToString(value IdentityAssuranceLevel): value.value\ndefine function ToString(value ImagingStudyStatus): value.value\ndefine function ToString(value ImmunizationEvaluationStatus): value.value\ndefine function ToString(value ImmunizationStatus): value.value\ndefine function ToString(value InvoicePriceComponentType): value.value\ndefine function ToString(value InvoiceStatus): value.value\ndefine function ToString(value IssueSeverity): value.value\ndefine function ToString(value IssueType): value.value\ndefine function ToString(value LinkType): value.value\ndefine function ToString(value LinkageType): value.value\ndefine function ToString(value ListMode): value.value\ndefine function ToString(value ListStatus): value.value\ndefine function ToString(value LocationMode): value.value\ndefine function ToString(value LocationStatus): value.value\ndefine function ToString(value MeasureReportStatus): value.value\ndefine function ToString(value MeasureReportType): value.value\ndefine function ToString(value MediaStatus): value.value\ndefine function ToString(value MedicationAdministrationStatus): value.value\ndefine function ToString(value MedicationDispenseStatus): value.value\ndefine function ToString(value MedicationKnowledgeStatus): value.value\ndefine function ToString(value MedicationRequestIntent): value.value\ndefine function ToString(value MedicationRequestPriority): value.value\ndefine function ToString(value MedicationRequestStatus): value.value\ndefine function ToString(value MedicationStatementStatus): value.value\ndefine function ToString(value MedicationStatus): value.value\ndefine function ToString(value MessageSignificanceCategory): value.value\ndefine function ToString(value Messageheader_Response_Request): value.value\ndefine function ToString(value MimeType): value.value\ndefine function ToString(value NameUse): value.value\ndefine function ToString(value NamingSystemIdentifierType): value.value\ndefine function ToString(value NamingSystemType): value.value\ndefine function ToString(value NarrativeStatus): value.value\ndefine function ToString(value NoteType): value.value\ndefine function ToString(value NutritiionOrderIntent): value.value\ndefine function ToString(value NutritionOrderStatus): value.value\ndefine function ToString(value ObservationDataType): value.value\ndefine function ToString(value ObservationRangeCategory): value.value\ndefine function ToString(value ObservationStatus): value.value\ndefine function ToString(value OperationKind): value.value\ndefine function ToString(value OperationParameterUse): value.value\ndefine function ToString(value OrientationType): value.value\ndefine function ToString(value ParameterUse): value.value\ndefine function ToString(value ParticipantRequired): value.value\ndefine function ToString(value ParticipantStatus): value.value\ndefine function ToString(value ParticipationStatus): value.value\ndefine function ToString(value PaymentNoticeStatus): value.value\ndefine function ToString(value PaymentReconciliationStatus): value.value\ndefine function ToString(value ProcedureStatus): value.value\ndefine function ToString(value PropertyRepresentation): value.value\ndefine function ToString(value PropertyType): value.value\ndefine function ToString(value ProvenanceEntityRole): value.value\ndefine function ToString(value PublicationStatus): value.value\ndefine function ToString(value QualityType): value.value\ndefine function ToString(value QuantityComparator): value.value\ndefine function ToString(value QuestionnaireItemOperator): value.value\ndefine function ToString(value QuestionnaireItemType): value.value\ndefine function ToString(value QuestionnaireResponseStatus): value.value\ndefine function ToString(value ReferenceHandlingPolicy): value.value\ndefine function ToString(value ReferenceVersionRules): value.value\ndefine function ToString(value ReferredDocumentStatus): value.value\ndefine function ToString(value RelatedArtifactType): value.value\ndefine function ToString(value RemittanceOutcome): value.value\ndefine function ToString(value RepositoryType): value.value\ndefine function ToString(value RequestIntent): value.value\ndefine function ToString(value RequestPriority): value.value\ndefine function ToString(value RequestStatus): value.value\ndefine function ToString(value ResearchElementType): value.value\ndefine function ToString(value ResearchStudyStatus): value.value\ndefine function ToString(value ResearchSubjectStatus): value.value\ndefine function ToString(value ResourceType): value.value\ndefine function ToString(value ResourceVersionPolicy): value.value\ndefine function ToString(value ResponseType): value.value\ndefine function ToString(value RestfulCapabilityMode): value.value\ndefine function ToString(value RiskAssessmentStatus): value.value\ndefine function ToString(value SPDXLicense): value.value\ndefine function ToString(value SearchComparator): value.value\ndefine function ToString(value SearchEntryMode): value.value\ndefine function ToString(value SearchModifierCode): value.value\ndefine function ToString(value SearchParamType): value.value\ndefine function ToString(value SectionMode): value.value\ndefine function ToString(value SequenceType): value.value\ndefine function ToString(value ServiceRequestIntent): value.value\ndefine function ToString(value ServiceRequestPriority): value.value\ndefine function ToString(value ServiceRequestStatus): value.value\ndefine function ToString(value SlicingRules): value.value\ndefine function ToString(value SlotStatus): value.value\ndefine function ToString(value SortDirection): value.value\ndefine function ToString(value SpecimenContainedPreference): value.value\ndefine function ToString(value SpecimenStatus): value.value\ndefine function ToString(value Status): value.value\ndefine function ToString(value StrandType): value.value\ndefine function ToString(value StructureDefinitionKind): value.value\ndefine function ToString(value StructureMapContextType): value.value\ndefine function ToString(value StructureMapGroupTypeMode): value.value\ndefine function ToString(value StructureMapInputMode): value.value\ndefine function ToString(value StructureMapModelMode): value.value\ndefine function ToString(value StructureMapSourceListMode): value.value\ndefine function ToString(value StructureMapTargetListMode): value.value\ndefine function ToString(value StructureMapTransform): value.value\ndefine function ToString(value SubscriptionChannelType): value.value\ndefine function ToString(value SubscriptionStatus): value.value\ndefine function ToString(value SupplyDeliveryStatus): value.value\ndefine function ToString(value SupplyRequestStatus): value.value\ndefine function ToString(value SystemRestfulInteraction): value.value\ndefine function ToString(value TaskIntent): value.value\ndefine function ToString(value TaskPriority): value.value\ndefine function ToString(value TaskStatus): value.value\ndefine function ToString(value TestReportActionResult): value.value\ndefine function ToString(value TestReportParticipantType): value.value\ndefine function ToString(value TestReportResult): value.value\ndefine function ToString(value TestReportStatus): value.value\ndefine function ToString(value TestScriptRequestMethodCode): value.value\ndefine function ToString(value TriggerType): value.value\ndefine function ToString(value TypeDerivationRule): value.value\ndefine function ToString(value TypeRestfulInteraction): value.value\ndefine function ToString(value UDIEntryType): value.value\ndefine function ToString(value UnitsOfTime): value.value\ndefine function ToString(value Use): value.value\ndefine function ToString(value VariableType): value.value\ndefine function ToString(value VisionBase): value.value\ndefine function ToString(value VisionEyes): value.value\ndefine function ToString(value VisionStatus): value.value\ndefine function ToString(value XPathUsageType): value.value\ndefine function ToString(value base64Binary): value.value\ndefine function ToBoolean(value boolean): value.value\ndefine function ToDate(value date): value.value\ndefine function ToDateTime(value dateTime): value.value\ndefine function ToDecimal(value decimal): value.value\ndefine function ToDateTime(value instant): value.value\ndefine function ToInteger(value integer): value.value\ndefine function ToString(value string): value.value\ndefine function ToTime(value time): value.value\ndefine function ToString(value uri): value.value\ndefine function ToString(value xhtml): value.value\n
Content not shown - (application/elm+xml, size = 421Kb)
Content not shown - (application/elm+json, size = 763Kb)
Related Artifacts
Parameters
| Patient | out | 0 | 1 | Patient |
| Get Immunization | out | 0 | * | Immunization |
| Immunization Status | out | 0 | * | |
| Immunization Completed | out | 0 | * | Immunization |
| Immunization Not Done | out | 0 | * | Immunization |
| Immunization StatusReason | out | 0 | * | CodeableConcept |
| Get Observations | out | 0 | * | Observation |
| Pregnant Observation | out | 0 | * | Observation |
| Pregnant Condition | out | 0 | * | Condition |
| Pregnant | out | 0 | 1 | boolean |
| Patient mother's pregnancy outcome observation | out | 0 | * | Resource |
| Preterm | out | 0 | * | Resource |
| Preterm Birth | out | 0 | * | Observation |
| Adverse Event | out | 0 | * | Observation |
| Allergy = True | out | 0 | * | AllergyIntolerance |
| Immunocompromised = True | out | 0 | 1 | boolean |
| Doses Administered to Patient | out | 0 | * | Immunization |
| Patient birth weight observation value | out | 0 | * | Quantity |
| Current Patient Age In Years | out | 0 | 1 | integer |
| Current Patient Age In Weeks | out | 0 | 1 | integer |
| Current Patient Age In Months | out | 0 | 1 | integer |
| Patient Biological Sex | out | 0 | 1 | |
| Patient HAART Treatment Start Date | out | 0 | 1 | dateTime |
| Patient HAART Treatment Started 6 to 12 Months Ago | out | 0 | 1 | boolean |
| Patient is receiving HAART | out | 0 | 1 | boolean |
| HIV Status | out | 0 | * | CodeableConcept |
| Live Attenuated Vaccines | out | 0 | * | Immunization |
| Date of Latest Live Attenuated Vaccine | out | 0 | 1 | dateTime |
Data Requirements
Contents
text/cql
library IMMZCommon\n\nusing FHIR version '4.0.1'\n\ninclude WHOCommon called WCom\ninclude WHOConcepts called Wcon\ninclude FHIRHelpers version '4.0.1'\ninclude FHIRCommon called FC\ninclude IMMZConcepts called IMMZc\n\n\ncode "[#] Births total": '11640-0' from IMMZc."LOINC" display 'Pregnancy outcome'\ncode "[#] Births.preterm": '11637-6' from IMMZc."LOINC" display 'Preterm'\ncontext Patient\n\n//TODO: Check patient is alive\n\n//Get patient immunizations\ndefine "Get Immunization":\n [Immunization]\n\n// check vaccine status\ndefine "Immunization Status":\n [Immunization] I\n return I.status\n\n//check Immunization.status for not-done\ndefine "Immunization Completed":\n [Immunization] I\n where I.status in {'completed'}\n\n//check Immunization.status for not-done\ndefine "Immunization Not Done":\n [Immunization] I\n where I.status in {'not-done'}\n\n//how do we handle entered-in-error? It seems like it should be different from not-done in how it should be handled? These should be ignored so we likely don't need to check for them. We should maybe set these to check for statuses like complete, or amended \n\n//check vaccine status reason - e.g. if vaccine was not given\ndefine "Immunization StatusReason":\n [Immunization] I\n return I.statusReason\n\n//define statusReason Immunizations for when it was not given\n\n//Procedure for vaccine administration\n\n//Get patient observations. Do we need this statement to get all Observations? \ndefine "Get Observations":\n [Observation]\n\n//Check if patient is pregnant\n//not sure if pregnancy is an Observation\ndefine "Pregnant Observation":\n [Observation] O\n //IPS Uses Observation - https://hl7.org/fhir/uv/ips/StructureDefinition-observation-pregnancy-status-uv-ips.html\n where (O.value as CodeableConcept) in Wcon."Pregnancy Status Pregnant"\n/*\nNeed to figure out how to add the OR Condition in case pregnancy is stored in a condition instead of an Observation \nor [Condition] C\n where (C.code as CodeableConcept) in Wcon."Pregnancy Status Pregnant"\n*/\n\n/*\ndefine "Patient Has Active Sickle-cell disease":\n exists([Condition: code = IMMZc."Sickle-cell Disease Condition"] C\n where C.clinicalStatus in FC."Active Condition"\n and C.abatement is null)\n*/\n\ndefine "Pregnant Condition":\n [Condition] C\n where (C.code as CodeableConcept) in Wcon."Pregnancy Status Pregnant"\n\ndefine "Pregnant": \n exists\n ( "Pregnant Observation")\n or exists ("Pregnant Condition")\n\n//Seronegative. Relevant for Dengue \n/*\ndefine "Individual is Seronegative for Dengue":\n [Observation] O\n where (O.value as CodeableConcept) in IMMZc.Seronegative\n*/\n\n//Total number of births including abortions, stillbirths and live births.\ndefine "Patient mother's pregnancy outcome observation":\n [Observation: code = "[#] Births total"] O\n return O.value\n\n// Total number of children whose birth occurred through the end of the last day of the 37th week (259th day) \n// following onset of the last menstrual period\ndefine "Preterm":\n [Observation: code = "[#] Births.preterm"] O\n return O.value\n\n//Observed Preterm birth\ndefine "Preterm Birth":\n [Observation] O\n where (O.value as CodeableConcept) in IMMZc.PretermBirth\n\n//@dataElement Adverse Event:\ndefine "Adverse Event":\n from [Immunization] I, [Observation] O\n where O.id in (I.reaction R return Last(Split(R.detail.reference, '/')))\n return O\n\n/* \n * @dataElement Allergy = True\n */\ndefine "Allergy = True":\n\t[AllergyIntolerance] A\n\twhere \n\tA.clinicalStatus ~ FC."allergy-active"\n\tand\n\tA.verificationStatus ~ FC."allergy-confirmed"\n\n/* \n * @dataElement Immunocompromised = True\n */\ndefine "Immunocompromised = True":\n\texists([Condition] C \n\twhere C.code in IMMZc."Immunocompromised"\n\tand\n \tC.clinicalStatus in FC."Active Condition"\n\tand\n\tC.verificationStatus ~ FC."confirmed")\n\n/**\n * @dataElement All Doses Administered to Patient to patient ordered newest to oldest\n */\ndefine "Doses Administered to Patient":\n [Immunization] I\n where I.status = 'completed'\n sort by date from (occurrence as FHIR.dateTime) desc\n\n\n/******************************\n * Test Results\n */\n\n\ndefine "Patient birth weight observation value":\n[Observation: code in IMMZc."Patient birth weight observation value"] O\n return O.value as FHIR.Quantity\n\n/** \n * @dataElement Patient age in years\n */\ndefine "Current Patient Age In Years":\n AgeInYearsAt(Today())\n //Today() - (Patient.birthDate as System.Date)\n\n/** \n * @dataElement Patient age in weeks\n */\ndefine "Current Patient Age In Weeks":\n AgeInWeeksAt(Today())\n\n/** \n * @dataElement Patient age in months\n */\ndefine "Current Patient Age In Months":\n AgeInMonthsAt(Today())\n\n/** \n * @dataElement Patient biological sex used for deciding vaccine eligibility\n * TODO: "Gender" of patient in FHIR is the administrative gender - or can we expect that this will be biological sex and administrative\n * gender identity will be captured using the gender identity extension?\n */\ndefine "Patient Biological Sex":\n Patient.gender\n\ndefine "Patient HAART Treatment Start Date":\n Last([MedicationAdministration] A \n where \n ExtractMedicationCode(A.medication) in IMMZc."ARV Drugs" \n and A.status in { 'active', 'complete' }\n and ExtractMedicationInitiationDate(A.effective) less than 12 'month' before Today()\n return ExtractMedicationInitiationDate(A.effective))\n\ndefine "Patient HAART Treatment Started 6 to 12 Months Ago":\n "Patient HAART Treatment Start Date" between Now() - 12 months and Now() - 6 months\n\n/**\n * @dataElement The patient has a medication record which indicates that they are receiving ARV\n */\ndefine "Patient is receiving HAART":\n //exists([MedicationStatement] S where ExtractMedicationCode(S.medication) in IMMZc."ARV Drugs" and S.status = 'active')\n //or \n exists([MedicationAdministration] A where ExtractMedicationCode(A.medication) in IMMZc."ARV Drugs" and A.status = 'in-progress')\n //union \n //\n\n/*\n @dataElement HIV Status observations of the patient most recent first\n*/\ndefine "HIV Status":\n [Observation: IMMZc."HIV status"] O\n where O.status in { 'final', 'amended', 'corrected' }\n and Coalesce(WCom.ModifierExtension(O, 'who-notDone').value, false) is false\n return O.value as FHIR.CodeableConcept\n\n/*\n @dataElement Date and time of last live attenuated vaccine\n*/\ndefine "Live Attenuated Vaccines":\n "Doses Administered to Patient" I where I.vaccineCode in IMMZc."Live Attenuated"\n\ndefine "Date of Latest Live Attenuated Vaccine":\n First("Live Attenuated Vaccines").occurrence as dateTime\n\n/******************************\n * CQL Helper Functions\n */\n\n/**\n * @description Fetches a singleton protocol applied from an immunization\n * @comment The protocol list from the immunization\n */\ndefine function Only(protocols List<FHIR.Immunization.ProtocolApplied>):\n singleton from protocols\n\n/**\n * @description Takes the date choice of a date/string choice (for Immunization date)\n */\ndefine function ToDate(choice Choice<FHIR.date, FHIR.string>):\n case\n\t when choice is FHIR.date then\n \tchoice as FHIR.date\n\t\telse\n Message(null as FHIR.date, true, '1', 'Error', 'Cannot compute a date from a String value')\n\tend\n\n/**\n * @description Takes the date choice of a date/string choice (for Immunization date)\n */\ndefine function ToDateTime(choice Choice<FHIR.dateTime, FHIR.string>):\n case\n\t when choice is FHIR.dateTime then\n \tchoice as FHIR.dateTime\n\t\telse\n Message(null as FHIR.dateTime, true, '1', 'Error', 'Cannot compute a date from a String value')\n\tend\n\n\n/**\n * @description Takes a choice of FHIR.string and FHIR.positiveInt and ensures the result is a FHIR.positiveInt\n */\ndefine function ToPositiveInt(choice Choice<FHIR.positiveInt, FHIR.string>):\n case\n\t when choice is FHIR.positiveInt then\n \tchoice as FHIR.positiveInt\n\t\telse\n Message(null as FHIR.positiveInt, true, '1', 'Error', 'Cannot compute a positive from a String value') // TODO: I'm sure that this is supported somehow?\n\tend\n\n\n/**\n * @description Takes a choice between a Medication and a CodeableConcept and returns just the code of the medication\n */\ndefine function ExtractMedicationCode(choice Choice<FHIR.CodeableConcept, FHIR.Reference>):\n case\n\t when choice is FHIR.CodeableConcept then\n \tchoice as FHIR.CodeableConcept\n when choice is FHIR.Reference then\n First([Medication] M \n where M.id = Last(Split(choice.reference, '/'))\n return M.code as FHIR.CodeableConcept)\n\t\telse\n Message(null as FHIR.CodeableConcept, true, '1', 'Error', 'Cannot compute a medication code') // TODO: I'm sure that this is supported somehow?\n\tend\n\n\n/**\n * @description Takes a choice between a Medication and a CodeableConcept and returns just the code of the medication\n */\ndefine function ExtractMedicationInitiationDate(choice Choice<FHIR.dateTime, FHIR.Period>):\n case\n\t when choice is FHIR.Period then\n \tstart of (choice as FHIR.Period)\n when choice is FHIR.dateTime then\n choice as FHIR.dateTime\n\t\telse\n Message(null as FHIR.dateTime, true, '1', 'Error', 'Cannot compute medication treatment initiation date') // TODO: I'm sure that this is supported somehow?\n\tend\n\n
Content not shown - (application/elm+xml, size = 124Kb)
Content not shown - (application/elm+json, size = 228Kb)
Related Artifacts
| depends-on | FHIR model information | http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 |
| depends-on | Library FHIRHelpers | http://fhir.org/guides/who/smart-immunization/Library/FHIRHelpers|4.0.1 |
| depends-on | Library WCom | WHOCommon |
| depends-on | Library IMMZCom | IMMZCommon |
| depends-on | Library IMMZc | IMMZConcepts |
| depends-on | Library IMMZvl | IMMZVaccineLibrary |
| depends-on | Code system Vaccines Administered | Vaccine Administered Value Set |
Parameters
| Immunization | out | 0 | 1 | Immunization |
| Geographic Region of Vaccine Administration | out | 0 | 1 | string |
| Dose Number of Vaccine Administration | out | 0 | 1 | positiveInt |
Data Requirements
Contents
text/cql
/**\n * Immunization Common Stratifiers by Patients as Context\n */\n\nlibrary IMMZCommonIzDataElements\n\nusing FHIR version '4.0.1'\n\ninclude FHIRHelpers version '4.0.1'\ninclude WHOCommon called WCom\ninclude IMMZCommon called IMMZCom\ninclude IMMZConcepts called IMMZc\ninclude IMMZVaccineLibrary called IMMZvl\n\ncodesystem "Vaccines Administered": 'http://hl7.org/fhir/ValueSet/vaccine-code'\n\n// Vaccines administered\ncode "BCG": 'BCG' from "Vaccines Administered" display 'BCG'\n//should this reference the BCG valueset from IMMZConcepts.cql? \n\ncontext Immunization\n\n// @dataElement: Geographic Region where the vaccination was provided\ndefine "Geographic Region of Vaccine Administration": \n WCom.Official([Location] L \n where L.id = Last(Split(Immunization.location.reference, '/'))\n return L.address).state\n\n// @dataElement: The vaccination dose sequence\ndefine "Dose Number of Vaccine Administration": \n IMMZCom.Only(Immunization.protocolApplied).doseNumber as FHIR.positiveInt\n
Content not shown - (application/elm+xml, size = 13Kb)
Content not shown - (application/elm+json, size = 22Kb)
Related Artifacts
Contents
text/cql
library IMMZConcepts\r\n\r\n// Code Systems\r\n//Probably can delete these once imported WHOConcepts\r\ncodesystem "ICD-10": 'http://hl7.org/fhir/sid/icd-10'\r\ncodesystem "SNOMED-CT": 'http://snomed.info/sct'\r\ncodesystem "LOINC": 'http://loinc.org'\r\ncodesystem "RxNorm": 'http://www.nlm.nih.gov/research/umls/rxnorm'\r\ncodesystem "CIEL": 'http://hl7.org/fhir/sid/ciel'\r\ncodesystem "ICD-11": 'http://hl7.org/fhir/sid/icd-11'\r\ncodesystem "ICHI": 'https://mitel.dimi.uniud.it/ichi/#http://id.who.int/ichi'\r\ncodesystem "ICF": 'http://hl7.org/fhir/sid/icf-nl'\r\ncodesystem "Extended Codes CodeSystem codes": 'http://fhir.org/guides/who/anc-cds/CodeSystem/anc-custom-codes'\r\n\r\n//WHO ATC IPS Valueset\r\nvalueset "WHO ATC": 'http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips'\r\n\r\n// General use ValueSets \r\nvalueset "Negative Result": 'http://fhir.org/guides/who/smart-immunization/ValueSet/Negativetestresult-values'\r\nvalueset "Positive Result": 'http://fhir.org/guides/who/smart-immunization/ValueSet/PositiveTestResult-values'\r\nvalueset "Immunocompromised": 'http://fhir.org/guides/who/smart-immunization/ValueSet/Immunocompromised-values'\r\nvalueset "Patient birth weight observation value": 'http://fhir.org/guides/who/smart-immunization/ValueSet/Birthweight-values'\r\nvalueset "PretermBirth": 'http://fhir.org/guides/who/smart-immunization/ValueSet/Preterm-values'\r\nvalueset "Live Attenuated": 'http://fhir.org/guides/who/smart-immunization/ValueSet/LiveAttenduatedVaccines'\r\n\r\n//valueset "Target Disease": 'http://hl7.org/fhir/ValueSet/immunization-target-disease'\r\n\r\nvalueset "HIV status": 'http://fhir.org/guides/who/smart-immunization/ValueSet/HIVstatus-values'\r\nvalueset "HIV status - HIV positive Choices": 'http://fhir.org/guides/who/anc-cds/ValueSet/anc-b9-de46'\r\nvalueset "HIV status - HIV negative Choices": 'http://fhir.org/guides/who/anc-cds/ValueSet/anc-b9-de47'\r\n\r\nvalueset "ARV Drugs": 'http://fhir.org/guides/who/smart-immunization/ValueSet/ARVDrugs-values'\r\n\r\n// Vaccine Value Sets\r\n\r\nvalueset "MCV Vaccine": 'http://fhir.org/guides/who/smart-immunization/ValueSet/IMMZ.A1.DE9'\r\n\r\n// Plugin is complaining about not finding these so that should be resolved, but here until it can be fixed\r\nvalueset "BCG Vaccine": 'http://fhir.org/guides/who/smart-immunization/ValueSet/IMMZ.A1.DE1'\r\nvalueset "Cholera Vaccine": 'http://fhir.org/guides/who/smart-immunization/ValueSet/IMMZ.A1.DE2'\r\n\r\n\r\n\r\ncode "Adverse Event Severity": '246112005' from "SNOMED-CT" display 'Severity (attribute)'\r\ncode "Adverse Event Manifestation": '246112005' from "SNOMED-CT" display 'Severity (attribute)'\r\n\r\n
Content not shown - (application/elm+xml, size = 11Kb)
Content not shown - (application/elm+json, size = 16Kb)
Related Artifacts
| depends-on | FHIR model information | http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 |
| depends-on | Library IMMZc | IMMZConcepts |
Parameters
| Patient | out | 0 | 1 | Patient |
| High incidence of TB and/or high leprosy burden | out | 0 | 1 | boolean |
| Polio-endemic country with high risk of spread | out | 0 | 1 | boolean |
| Polio dose scheme | out | 0 | 1 | string |
| Country has a high risk of exposure to polio | out | 0 | 1 | boolean |
| High Coverage of Polio and Risk of Wild Importation | out | 0 | 1 | boolean |
| In a country where the peak burden of severe Hib disease occurs in young infants | out | 0 | 1 | boolean |
| In a setting where the greatest disease morbidity and mortality occur later, or whererate reductions of disease are not fully sustained after the routine use of Hib vaccine | out | 0 | 1 | boolean |
| Hib dose scheme | out | 0 | 1 | string |
| Hepatitis A endemic country | out | 0 | 1 | boolean |
| Japanese Encephalitis dose scheme | out | 0 | 1 | string |
| Country recognizes JE as a health priority | out | 0 | 1 | boolean |
| Pneumococcal dose scheme | out | 0 | 1 | string |
| Country is not highly endemic for Hepatitis A | out | 0 | 1 | boolean |
| Country is administering a Live attenuated HAV vaccine | out | 0 | 1 | boolean |
| In a setting with a high disease burden and mortality | out | 0 | 1 | boolean |
| Region recommends Meningococcal vaccination | out | 0 | 1 | boolean |
| Region recommends Cholera vaccination | out | 0 | 1 | boolean |
| Region recommends Typhoid vaccination | out | 0 | 1 | boolean |
| Country is administering the TCV vaccine | out | 0 | 1 | boolean |
| Country is administering ViPS vaccine | out | 0 | 1 | boolean |
| Country is administering an Inactivated HAV vaccine | out | 0 | 1 | boolean |
| In a setting where the risk of measles among infants < 9 months of age remains high | out | 0 | 1 | boolean |
| Country currently has a measles outbreak | out | 0 | 1 | boolean |
| Population is in conflict zones internally displaced populations and refugees | out | 0 | 1 | boolean |
| In a setting where there is high transmission of Measles | out | 0 | 1 | boolean |
| In a setting where there is low transmission of Measles | out | 0 | 1 | boolean |
| Country has Yellow Fever Endemic | out | 0 | 1 | boolean |
| Country recognizes TBE as a priority | out | 0 | 1 | boolean |
| There is a compelling reason to vaccinate infants with Meningococcal between 3 to 9 months old | out | 0 | 1 | boolean |
| Country recognizes Varicella an important public health burden | out | 0 | 1 | boolean |
| Country recognizes MUMPS reduction as a public health priority | out | 0 | 1 | boolean |
| Country is using a 3 dose series ROTA product | out | 0 | 1 | boolean |
Data Requirements
Contents
text/cql
library IMMZConfig\nusing FHIR version '4.0.1'\ninclude IMMZConcepts called IMMZc\n\ncontext Patient \n\ndefine "High incidence of TB and/or high leprosy burden": true\ndefine "Polio-endemic country with high risk of spread": true\n/*\ndefine "Combined bOPV and IPV Schedule": true\ndefine "Sequential IPV-OPV Schedule": true\n*/\n/*\n * Possible Polio dose schemes are 'combined', 'sequential', or 'ipv'\n */\ndefine "Polio dose scheme": 'combined'\ndefine "Country has a high risk of exposure to polio": true\ndefine "High Coverage of Polio and Risk of Wild Importation": true\n\ndefine "In a country where the peak burden of severe Hib disease occurs in young infants":true\ndefine "In a setting where the greatest disease morbidity and mortality occur later, or whererate reductions of disease are not fully sustained after the routine use of Hib vaccine": true\ndefine "Hib dose scheme": '1p'\ndefine "Hepatitis A endemic country": true\n\ndefine "Japanese Encephalitis dose scheme": 'attenuated'\n/*\ndefine "Country is administering Live recombinant JE antigen":true\ndefine "Country is administering Live attentuated JE antigen": true\ndefine "Country is administering Inactivated Vero cell-derived JE antigen": true\n*/\ndefine "Country recognizes JE as a health priority": true\n\n/*\ndefine "Country is following a 2 dose scheme for Pneumococcal": true\ndefine "Country is following a 3 dose scheme for Pneumococcal": true\n*/\ndefine "Pneumococcal dose scheme": '2p+1'\ndefine "Country is not highly endemic for Hepatitis A":true\ndefine "Country is administering a Live attenuated HAV vaccine": true\ndefine "In a setting with a high disease burden and mortality": true\n\ndefine "Region recommends Meningococcal vaccination": true\ndefine "Region recommends Cholera vaccination": true\ndefine "Region recommends Typhoid vaccination": true\ndefine "Country is administering the TCV vaccine": true\ndefine "Country is administering ViPS vaccine": true\ndefine "Country is administering an Inactivated HAV vaccine": true\ndefine "In a setting where the risk of measles among infants < 9 months of age remains high": false\ndefine "Country currently has a measles outbreak": false\ndefine "Population is in conflict zones internally displaced populations and refugees": false\ndefine "In a setting where there is high transmission of Measles":false\ndefine "In a setting where there is low transmission of Measles":false\n\ndefine "Country has Yellow Fever Endemic": true\ndefine "Country recognizes TBE as a priority": true\n\ndefine "There is a compelling reason to vaccinate infants with Meningococcal between 3 to 9 months old": true\ndefine "Country recognizes Varicella an important public health burden": true\ndefine "Country recognizes MUMPS reduction as a public health priority": true\ndefine "Country is using a 3 dose series ROTA product": true\n// TODO: \n//define "bOPV and IPV Schedule":\n//\t'combined'\n\t//'sequential';\n\n\n
Content not shown - (application/elm+xml, size = 18Kb)
Content not shown - (application/elm+json, size = 29Kb)
Related Artifacts
Parameters
| Individual is at high risk of contracting measles | in | 0 | 1 | boolean |
| Individual is travelling to a country experiencing measles outbreaks | in | 0 | 1 | boolean |
| Individual is known to be HIV-infected or exposed | in | 0 | 1 | boolean |
| Immune reconstitution was achieved | in | 0 | 1 | boolean |
| Patient | out | 0 | 1 | Patient |
| MCV Dose Contraindicated | out | 0 | 1 | boolean |
| MCV Doses Administered to Patient | out | 0 | * | Immunization |
| High Transmission Setting | out | 0 | 1 | boolean |
| First MCV Dose Administered to Patient | out | 0 | 1 | Immunization |
| Date First MCV Dose Administered to Patient | out | 0 | 1 | date |
| Second MCV Dose Administered to Patient | out | 0 | 1 | Immunization |
| Date Second MCV Dose Administered to Patient | out | 0 | 1 | date |
| Supplementary MCV Dose Administered to Patient | out | 0 | 1 | Immunization |
| Needs Supplementary MCV Dose | out | 0 | 1 | boolean |
| Provision of the MCV dose | out | 0 | 1 | boolean |
| No MCV Doses Administered to Patient | out | 0 | 1 | boolean |
| Needs Zero MCV Dose | out | 0 | 1 | boolean |
| Expected Due Date for MCV dose | out | 0 | 1 | date |
| Schedule Due Date for MCV dose | out | 0 | 1 | dateTime |
| Zero MCV Dose Administered to Patient | out | 0 | 1 | Immunization |
| MCV Next Dose Number | out | 0 | 1 | Resource |
| Number of Required MCV Doses | out | 0 | 1 | integer |
| Expiration Date for MCV dose | out | 0 | 1 | date |
| Overdue Date for MCV dose | out | 0 | 1 | Resource |
| Date Supplementary MCV Dose Administered to Patient | out | 0 | 1 | date |
| Date Zero MCV Dose Administered to Patient | out | 0 | 1 | date |
| Date Last Valid MCV Dose | out | 0 | 1 | date |
| Should vaccinate patient for MCV | out | 0 | 1 | boolean |
| Date Last MCV Dose Administered to Patient | out | 0 | 1 | date |
| Number of MCV Doses Administered to Patient | out | 0 | 1 | integer |
Data Requirements
Contents
text/cql
/*\n * Library: IMMZD2DTMeasles (IMMZ.D2.DT.Measles)\n * Rule: If the child or patient has not been given MCV1 (at 9 months) and MCV2 (between 15-18 months) vaccination \n * Trigger: Patient has never received measles vaccination\n */\nlibrary IMMZD2DTMeasles\n// Start Skeleton CQL\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\ninclude IMMZCommon called IMMZCom\ninclude IMMZConcepts called IMMZc\ninclude IMMZConfig called IMMZCon\ninclude IMMZVaccineLibrary called IMMZvl\ninclude FHIRCommon called FC\n\nparameter "Individual is at high risk of contracting measles" Boolean default false\nparameter "Individual is travelling to a country experiencing measles outbreaks" Boolean default false\nparameter "Individual is known to be HIV-infected or exposed" Boolean default false\nparameter "Immune reconstitution was achieved" Boolean default false\n\n// End Skeleton CQL\ncontext Patient\n\n\n/**\n * @dataElement Should provision MCV Dose\n */\ndefine "Provision of the MCV dose":\n\tnot("MCV Dose Contraindicated") \n and if exists(IMMZCom."Live Attenuated Vaccines") then IMMZCom."Date of Latest Live Attenuated Vaccine" + 4 weeks <= Now() else true\n\tand (\n\t\t"Second MCV Dose Administered to Patient" is null or\n\t\t(\n\t\t\t"Needs Supplementary MCV Dose" and "Supplementary MCV Dose Administered to Patient" is null\n\t\t)\n\t)\n\tand IMMZCom."Current Patient Age In Years" < 15\n\ndefine "Schedule Due Date for MCV dose":\n\tif IMMZCom."Date of Latest Live Attenuated Vaccine" is null or "Expected Due Date for MCV dose" > IMMZCom."Date of Latest Live Attenuated Vaccine" + 4 weeks\n\tthen "Expected Due Date for MCV dose"\n\telse IMMZCom."Date of Latest Live Attenuated Vaccine" + 4 weeks\n\ndefine "Expected Due Date for MCV dose":\n\tcase \n\twhen "Needs Zero MCV Dose"\n\t\tthen Patient.birthDate + 6 months\n\twhen "No MCV Doses Administered to Patient"\n\t\tthen if "High Transmission Setting" then Patient.birthDate + 9 months else Patient.birthDate + 12 months\n\twhen "Second MCV Dose Administered to Patient" is not null and "Needs Supplementary MCV Dose"\n\t\tthen "Date Second MCV Dose Administered to Patient" + 4 weeks\n\twhen "First MCV Dose Administered to Patient" is not null\n\t\tthen Patient.birthDate + 15 months\n\telse null\n\tend\n\n\ndefine "MCV Next Dose Number":\n\tif "Needs Zero MCV Dose" or "Zero MCV Dose Administered to Patient" is not null\n\tthen \n\t\tcase \n\t\twhen "Second MCV Dose Administered to Patient" is not null and "Needs Supplementary MCV Dose" then 'booster'\n\t\twhen "First MCV Dose Administered to Patient" is not null then 2\n\t\twhen "Zero MCV Dose Administered to Patient" is not null then 1\n\t\telse 'zero'\n\t\tend\n\telse\n\t\tcase \n\t\twhen "Second MCV Dose Administered to Patient" is not null and "Needs Supplementary MCV Dose" then 'booster'\n\t\twhen "First MCV Dose Administered to Patient" is not null then 2\n\t\telse 1\n\t\tend\n\ndefine "Number of Required MCV Doses":\n\t2\n\ndefine "Expiration Date for MCV dose":\n\tcase\n\twhen "Needs Zero MCV Dose"\n\t\tthen Patient.birthDate + 9 months\n\telse null\n\tend\n\ndefine "Overdue Date for MCV dose":\n\tnull\n\ndefine "Date Last Valid MCV Dose":\n\tcase \n\twhen "Supplementary MCV Dose Administered to Patient" is not null then "Date Supplementary MCV Dose Administered to Patient"\n\twhen "Second MCV Dose Administered to Patient" is not null then "Date Second MCV Dose Administered to Patient"\n\twhen "First MCV Dose Administered to Patient" is not null then "Date First MCV Dose Administered to Patient"\n\twhen "Zero MCV Dose Administered to Patient" is not null then "Date Zero MCV Dose Administered to Patient"\n\telse null\n\tend\n\ndefine "Should vaccinate patient for MCV":\n\t"Provision of the MCV dose" and ("Schedule Due Date for MCV dose" <= (Now()))\n\ndefine "MCV Dose Contraindicated":\n\tIMMZCom."Pregnant"\n\n/**\n * @dataElement MCV containing Doses Administered to Patient\n */\ndefine "MCV Doses Administered to Patient":\n IMMZCom."Doses Administered to Patient" I\n where\n I.vaccineCode in IMMZc."MCV Vaccine"\n\n/**\n * @define The patient has no MCV doses administered\n */\ndefine "No MCV Doses Administered to Patient":\n not exists("MCV Doses Administered to Patient")\n\n\n/** \n * @dataElement Date of last MCV dose administration\n */\ndefine "Date Last MCV Dose Administered to Patient":\n date from (First("MCV Doses Administered to Patient").occurrence as FHIR.dateTime)\n\n/**\n * @define The number of MCV doses administerd to the patient\n */\ndefine "Number of MCV Doses Administered to Patient":\n Count("MCV Doses Administered to Patient")\n\ndefine "High Transmission Setting":\n\t(\n\t\tIMMZCon."Country currently has a measles outbreak" or\n\t\tIMMZCon."In a setting where the risk of measles among infants < 9 months of age remains high" or\n\t\tIMMZCon."Population is in conflict zones internally displaced populations and refugees" or \n\t\t"Individual is at high risk of contracting measles" or\n\t\t"Individual is travelling to a country experiencing measles outbreaks" or\n\t\t"Individual is known to be HIV-infected or exposed"\n\t)\n\ndefine "Needs Zero MCV Dose":\n\t"No MCV Doses Administered to Patient" \n\t and (\n\t\t\tif "High Transmission Setting" \n\t\t\tthen IMMZCom."Current Patient Age In Months" between 6 and 9 \n\t\t\telse IMMZCom."Current Patient Age In Months" between 6 and 12\n\t\t)\n\t\tand IMMZCom."Date of Latest Live Attenuated Vaccine" +4 weeks <= Now()\n\t\tand \n\t\t\t(\n\t\t\t\t(\n\t\t\t\t\tIMMZCom."HIV Status" in IMMZc."HIV status - HIV positive Choices" \n\t\t\t\t\t and (\n\t\t\t\t\t not(IMMZCom."Patient is receiving HAART")\n\t\t\t\t\t\t\tor "Immune reconstitution was achieved"\n\t\t\t\t\t\t)\n\t\t\t\t)\n\t\t\t\tor "Individual is known to be HIV-infected or exposed"\n\t\t\t)\n\ndefine "Needs Supplementary MCV Dose":\n\tIMMZCom."HIV Status" in IMMZc."HIV status - HIV positive Choices" \n\tand IMMZCom."Current Patient Age In Years" < 15\n\tand IMMZCom."Patient is receiving HAART"\n\tand "Immune reconstitution was achieved" \n\tand "Supplementary MCV Dose Administered to Patient" is null\n\tand IMMZCom."Date of Latest Live Attenuated Vaccine" +4 weeks <= Now()\n\n\n/**\n * @dataElement Zero MCV dose given to Patient\n */\ndefine "Zero MCV Dose Administered to Patient":\n\tLast("MCV Doses Administered to Patient" I where I.occurrence between Patient.birthDate + 6 months and Patient.birthDate + 9 months)\n\n/**\n * @dataElement Date Zero MCV dose administered\n */\ndefine "Date Zero MCV Dose Administered to Patient":\n date from ("Zero MCV Dose Administered to Patient".occurrence as FHIR.dateTime)\n\n/**\n * @dataElement First MCV dose given to Patient\n */\ndefine "First MCV Dose Administered to Patient":\n\tif "High Transmission Setting"\n\tthen Last("MCV Doses Administered to Patient" I where I.occurrence after Patient.birthDate + 9 months)\n\telse Last("MCV Doses Administered to Patient" I where I.occurrence after Patient.birthDate + 12 months)\n/**\n * @dataElement Date first MCV dose administered\n */\ndefine "Date First MCV Dose Administered to Patient":\n date from ("First MCV Dose Administered to Patient".occurrence as FHIR.dateTime)\n\n/**\n * @dataElement "Second MCV Dose Administered to Patient"\n * only valid if 4 weeks after first dose\n */\ndefine "Second MCV Dose Administered to Patient":\n Last("MCV Doses Administered to Patient" I \n\t\twhere I.occurrence after "Date First MCV Dose Administered to Patient" + 4 weeks \n\t\t\tand I.occurrence after Patient.birthDate + 15 months)\n\n/**\n * @dataElement Date second MCV dose administered\n */\ndefine "Date Second MCV Dose Administered to Patient":\n date from ("Second MCV Dose Administered to Patient".occurrence as FHIR.dateTime)\n\n/**\n * @dataElement "Second MCV Dose Administered to Patient"\n * only valid if 4 weeks after first dose\n */\ndefine "Supplementary MCV Dose Administered to Patient":\n Last("MCV Doses Administered to Patient" I where I.occurrence after "Date Second MCV Dose Administered to Patient")\n\n/**\n * @dataElement Date second MCV dose administered\n */\ndefine "Date Supplementary MCV Dose Administered to Patient":\n date from ("Supplementary MCV Dose Administered to Patient".occurrence as FHIR.dateTime)\n\n/*\n * Rule: Should vaccinate patient for measles (Supplementary) because no doses\n * Annotations:\n * \t - Provide measles immunization Supplementary dose - Using the "MCV0 Vaccine immunization - NO Previous" schedule (Supplementary dose zero)\n * \t - \n * Outputs:\n * \t - Immunize patient for Measles - No doses\n * \t - \n * References:\n * \t- WHO recommendations for routine immunization - summary tables: https://www.who.int/teams/immunization-vaccines-and-biologicals/policies/who-recommendations-for-routine-immunization---summary-tables\n * \t- \n * Logic:\n *\t ((((((((((("Measles vaccine immunization history" = "No-doses" = true) and ("Current Patient Age in Months" > 6)) and ("HIV Status" = "Positive" = true)) and ("Current Patient Age in Months" < 9)) and ("Patient is receiving HAART" = false)) or (((("Measles vaccine immunization history" = "No-doses" = true) and ("Current Patient Age in Months" > 6)) and ("Country currently has a measles outbreak" = true)) and ("Current Patient Age in Months" < 9))) or (((("Measles vaccine immunization history" = "No-doses" = true) and ("Current Patient Age in Months" > 6)) and ("In a setting where the risk of measles among infants < 9 months of age remains high" = true)) and ("Current Patient Age in Months" < 9))) or (((("Measles vaccine immunization history" = "No-doses" = true) and ("Current Patient Age in Months" > 6)) and ("Population is in conflict zones internally displaced populations and refugees" = true)) and ("Current Patient Age in Months" < 9))) or (((("Measles vaccine immunization history" = "No-doses" = true) and ("Current Patient Age in Months" > 6)) and ("Individual is at high risk of contracting measles (e.g. contacts of known measles cases or in settings with increased risk of exposure during outbreaks suck as day-care facilities" = true)) and ("Current Patient Age in Months" < 9))) or (((("Measles vaccine immunization history" = "No-doses" = true) and ("Current Patient Age in Months" > 6)) and ("Individual is travelling to a country experiencing measles outbreaks" = true)) and ("Current Patient Age in Months" < 9))) or (((("Measles vaccine immunization history" = "No-doses" = true) and ("Current Patient Age in Months" > 6)) and ("Individual is known to be HIV-infected or exposed (i.e. born to an HIV-infected woman" = true)) and ("Current Patient Age in Months" < 9)))\n */\n /*\ndefine "Should vaccinate patient for measles (Supplementary) because no doses":\n\tIMMZCom."No MCV Doses Administered to Patient" and \n\t(\n\t\tIMMZCom."Current Patient Age In Months" between 6 and 9 and\n\t\t(\n\t\t\t(\n\t\t\t\tIMMZCom."HIV Status" in IMMZc."HIV status - HIV positive Choices" and\n\t\t\t\tnot(IMMZCom."Patient is receiving HAART")\n\t\t\t)\n\t\t\tor \n\t\t\t(\n\t\t\t\tIMMZCon."Country currently has a measles outbreak" or\n\t\t\t\tIMMZCon."In a setting where the risk of measles among infants < 9 months of age remains high" or\n\t\t\t\tIMMZCon."Population is in conflict zones internally displaced populations and refugees" or \n\t\t\t\t"Individual is at high risk of contracting measles" or\n\t\t\t\t"Individual is travelling to a country experiencing measles outbreaks" or\n\t\t\t\t"Individual is known to be HIV-infected or exposed"\n\t\t\t)\n\t\t)\n\t)\n*/\n\n/*\n * Rule: Should vaccinate patient for measles because no doses in a 2 dose scheme\n * Annotations:\n * \t - Provide measles immunization 1st dose - Using the "MCV1 Vaccine immunization - NO Previous" schedule (2 doses scheme)\n * \t - \n * Outputs:\n * \t - Immunize patient for Measles - No doses\n * \t - \n * References:\n * \t- WHO recommendations for routine immunization - summary tables: https://www.who.int/teams/immunization-vaccines-and-biologicals/policies/who-recommendations-for-routine-immunization---summary-tables\n * \t- \n * Logic:\n *\t ((((("Measles vaccine immunization history" = "No-doses" = true) and ("Current Patient Age in Months" >= 9)) and ("In a setting where there is high transmission of Measles" = true)) and ("Pregnancy Status" = false)) or ((("Measles vaccine immunization history" = "No-doses" = true) and ("Current Patient Age in Months" >= 12)) and ("In a setting where there is low transmission of Measles" = true)))\n */\n /*\ndefine "Should vaccinate patient for measles because no doses in a 2 dose scheme":\n\tIMMZCom."No MCV Doses Administered to Patient" and not(IMMZCom."Pregnant") and\n\t(\n\t\t(\n\t\t\tIMMZCom."Current Patient Age In Months" >= 9 and\n\t\t\tIMMZCon."In a setting where there is high transmission of Measles"\n\t\t) or (\n\t\t\tIMMZCom."Current Patient Age In Months" >= 12 and\n\t\t\tIMMZCon."In a setting where there is low transmission of Measles"\n\t\t)\n\t)\n*/\n\n/*\n * Rule: Should vaccinate patient for measles because 1 dose in a 2 dose scheme\n * Annotations:\n * \t - Provide measles immunization 1st dose - Using the "MCV2 Vaccine immunization - 1 Previous" schedule (2 doses scheme)\n * Outputs:\n * \t - Immunize patient for Measles - 1 Dose\n * References:\n * \t- WHO recommendations for routine immunization - summary tables: https://www.who.int/teams/immunization-vaccines-and-biologicals/policies/who-recommendations-for-routine-immunization---summary-tables\n * Logic:\n *\t (((("Measles vaccine immunization history" = "1-dose" = true) and ("Current Patient Age in Months" >= 15)) and ("Date last Measles dose given" >= "4 weeks")) and ("Pregnancy Status" = false))\n */\n /*\ndefine "Should vaccinate patient for measles because 1 dose in a 2 dose scheme":\n\tIMMZCom."Number of MCV Doses Administered to Patient" = 1 and\n\tIMMZCom."Current Patient Age In Months" >= 15 and\n\tIMMZCom."Date Last MCV Dose Administered to Patient" more than 4 'week' before Today() and\n\tnot (IMMZCom."Pregnant")\n*/\n\n/*\n * Rule: Should vaccinate patient for measles Supplementary dose because HIV positive and started HAART\n * Annotations:\n * \t - Provide measles immunization Supplementary dose - Using the "MCV Vaccine immunization" schedule (additional Supplementary dose)\n * \t - \n * Outputs:\n * \t - Immunize patient for Measles Supplementary\n * \t - \n * References:\n * \t- WHO recommendations for routine immunization - summary tables: https://www.who.int/teams/immunization-vaccines-and-biologicals/policies/who-recommendations-for-routine-immunization---summary-tables\n * \t- \n * Logic:\n *\t ((((("HIV Status" = "Positive" = true) and ("Patient is receiving HAART" = true)) and ("Immune reconstitution was achieved" = true)) and ("Pregnancy Status" = false)) or (((((("HIV Status" = "Positive" = true) and ("Patient is receiving HAART" = true)) and ("CD4+ T Lymphocyte monitoring is available" = false)) and ("Time since HAART was initiated in Months" >= 6)) and ("Time since HAART was initiated in Months" <= 12)) and ("Pregnancy Status" = false)))\n */\n /*\ndefine "Should vaccinate patient for measles Supplementary dose because HIV positive and started HAART":\n\tnot(IMMZCom."Pregnant") and\n\tIMMZCom."HIV Status" in IMMZc."HIV status - HIV positive Choices" and\n\tIMMZCom."Patient is receiving HAART" and \n\t(\n\n\t\t"Immune reconstitution was achieved" or\n\t\tnot exists(IMMZCom."Observed CD4% Measurements")\n\t\tand IMMZCom."Patient HAART Treatment Started 6 to 12 Months Ago"\n\t)\n*/\n
Content not shown - (application/elm+xml, size = 110Kb)
Content not shown - (application/elm+json, size = 198Kb)
Related Artifacts
| depends-on | FHIR model information | http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 |
| depends-on | Library FHIRHelpers | http://fhir.org/guides/who/smart-immunization/Library/FHIRHelpers|4.0.1 |
| depends-on | Library IMMZCom | IMMZCommon |
| depends-on | Library IMMZc | IMMZConcepts |
| depends-on | Library IMMZCon | IMMZConfig |
| depends-on | Library IMMZIndCom | IMMZIndicatorCommon |
| depends-on | Library IMMZvl | IMMZVaccineLibrary |
| depends-on | Library FC | FHIRCommon |
| depends-on | Library Measles | IMMZD2DTMeasles |
| depends-on | Code system Administrative Gender Codes | AdministrativeGender |
| depends-on | Code system ISO-8601-Derived Periods | http://ohie.org/CodeSystem/iso-8601-derived-periods |
| depends-on | Value set MCV Vaccine | Measles |
Parameters
| Measurement Period | in | 0 | 1 | Period |
| Patient | out | 0 | 1 | Patient |
| Initial Population 05 | out | 0 | 1 | Immunization |
| Measure Population 05 | out | 0 | 1 | Immunization |
| Initial Population 40 | out | 0 | 1 | Immunization |
| Measure Population 40 | out | 0 | 1 | Immunization |
| Stratification | out | 0 | 1 | string |
Data Requirements
Contents
text/cql
/*\n * Library: IMMZ.IND.Measles\n * Immunization coverage for Measles containing vaccine (Estimated Denominator) \n * Compares the administered doses of measles containing vaccines (MCV) with the estimated number of surviving infants (if dose 1) or a country supplied denominator (if dose 2) expressed as a percentage. \n * \n * Numerator: Number of administrations of vaccinations containing a Measles component during reporting period \n * Numerator Computation: COUNT immunization events WHERE administered product is a Measles vaccine (IMMZ.A1.DE9) during reporting period\n * Denominator: Estimated number of surviving infants (for dose 1) and country supplied denominator for dose sequence 2 (see comments)\n * Denominator Computation: PARAMETER number of surviving infants (if Dose Sequence = 1) or PARAMETER of country supplied denominator (if Dose Sequence = 2)\n * \n * Disaggregation:\n * - Dose Sequence (1, 2)\n * - Age Group (< 1 year or > 1 year)\n * - Geographic Region\n * - Administrative Gender (or Biological Sex)\n * \n * References: WHO Immunization Facility Analysis Guide (1), WHO / UNICEF Joint Reporting Form (3 - elements 4240 and 4260 )\n */\n\nlibrary IMMZINDMeasles\n\n// Start Skeleton CQL\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\ninclude IMMZCommon called IMMZCom\ninclude IMMZConcepts called IMMZc\ninclude IMMZConfig called IMMZCon\ninclude IMMZIndicatorCommon called IMMZIndCom\ninclude IMMZVaccineLibrary called IMMZvl\ninclude FHIRCommon called FC\ninclude IMMZD2DTMeasles called Measles\n// End Skeleton CQL\nparameter "Measurement Period" Interval<Date>\n\ncontext Patient\n\n/*\ndefine "MCV Doses Administered to Patient During Measurement Period":\n Measles."MCV Doses Administered to Patient" I \n where IMMZCom.ToDate(I.occurrence) during "Measurement Period"\n*/\n\n/*\n * Target population for first dose: Any one over 9 (in high transmission area) or 12 (in low transmission area) months old\n */ \ndefine "Initial Population 05":\n\tMeasles."First MCV Dose Administered to Patient" I where IMMZCom.ToDate(I.occurrence) during "Measurement Period"\n\n/*\n * Numerator for first dose: Anyone having received the first dose\n */\ndefine "Measure Population 05":\n\t"Initial Population 05"\n\n/*\n * Target population for second dose: Any one over 15 months\n */ \ndefine "Initial Population 40":\n\tMeasles."Second MCV Dose Administered to Patient" I where IMMZCom.ToDate(I.occurrence) during "Measurement Period"\n\n/*\n * Numerator for second dose: Anyone having received the first dose\n */\ndefine "Measure Population 40":\n\t"Initial Population 40"\n\n\n/*\n * Combined stratifiers\n */\ndefine "Stratification":\n\t\tIMMZIndCom."By Administrative Gender Stratifier".code + ':' + IMMZIndCom."Toddler By Age Stratifier".code + ':' + IMMZIndCom."By Geographic Region Stratifier"\n\n\n
Content not shown - (application/elm+xml, size = 18Kb)
Content not shown - (application/elm+json, size = 31Kb)
Related Artifacts
| depends-on | FHIR model information | http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 |
| depends-on | Library FHIRHelpers | http://fhir.org/guides/who/smart-immunization/Library/FHIRHelpers|4.0.1 |
| depends-on | Library FC | FHIRCommon |
| depends-on | Library IMMZCom | IMMZCommon |
| depends-on | Library IMMZc | IMMZConcepts |
| depends-on | Library WCom | WHOCommon |
| depends-on | Library WC | WHOConcepts |
| depends-on | Code system ISO-8601-Derived Periods | http://ohie.org/CodeSystem/iso-8601-derived-periods |
| depends-on | Code system Administrative Gender Codes | AdministrativeGender |
| depends-on | Value set Adverse Events | SNOMED CT Clinical Findings |
Parameters
| Measurement Period | in | 0 | 1 | Period |
| Patient | out | 0 | 1 | Patient |
| Newborn By Age Stratifier | out | 0 | 1 | Coding |
| Infant By Age Stratifier | out | 0 | 1 | Coding |
| Toddler By Age Stratifier | out | 0 | 1 | Coding |
| Adolescent By Age Stratifier | out | 0 | 1 | Coding |
| RCV By Age Stratifier | out | 0 | 1 | Coding |
| Varicella By Age Stratifier | out | 0 | 1 | Coding |
| Seasonal Influenza By Age Stratifier | out | 0 | 1 | Coding |
| By Administrative Gender Stratifier | out | 0 | 1 | Coding |
| By Geographic Region Stratifier | out | 0 | 1 | string |
| Patient Deceased During Measurement Period | out | 0 | 1 | boolean |
| Patient Born During Measurement Period | out | 0 | 1 | boolean |
| Patient Under 12 Months Old During Measurement Period | out | 0 | 1 | boolean |
| Patient Under 2 Years Old During Measurement Period | out | 0 | 1 | boolean |
| Immunizations with Adverse Events During Measurement Period | out | 0 | * | Immunization |
| Adverse Event Reactions During Measurement Period | out | 0 | * | Observation |
| Doses Administered to Patient During Measurement Period | out | 0 | * | Immunization |
Data Requirements
Contents
text/cql
/**\n * Immunization Common Stratifiers by Patients as Context\n */\n\nlibrary IMMZIndicatorCommon\n\nusing FHIR version '4.0.1'\n\ninclude FHIRHelpers version '4.0.1'\ninclude FHIRCommon called FC\ninclude IMMZCommon called IMMZCom\ninclude IMMZConcepts called IMMZc\ninclude WHOCommon called WCom\ninclude WHOConcepts called WC\ncodesystem "ISO-8601-Derived Periods": 'http://ohie.org/CodeSystem/iso-8601-derived-periods'\nparameter "Measurement Period" Interval<Date> default Interval[@2020-01-01, @2020-12-31]\n\n// Age Groups for Vaccines for infants\ncode "P0Y--P1Y": 'P0Y--P1Y' from "ISO-8601-Derived Periods" display '< 1 year'\ncode "P1Y--P9999Y": 'P1Y--P9999Y' from "ISO-8601-Derived Periods" display '> 1 year'\n\n// Age Groups for Vaccines for Toddlers\ncode "P0Y--P2Y": 'P0Y--P2Y' from "ISO-8601-Derived Periods" display '< 2 years'\ncode "P1Y--P2Y": 'P1Y--P2Y' from "ISO-8601-Derived Periods" display '1 year'\ncode "P2Y--P9999Y": 'P2Y--P9999Y' from "ISO-8601-Derived Periods" display '> 2 years'\n\n// Age groups for newborns\ncode "PT0H--PT24H": 'PT0H--PT24H' from "ISO-8601-Derived Periods" display 'Within 24H of Birth'\ncode "PT24H--P2W": 'PT24H--P2W' from "ISO-8601-Derived Periods" display '< 2 Weeks'\ncode "P2W--P9999Y": 'P2W--P9999Y' from "ISO-8601-Derived Periods" display '> 2 Weeks'\n\n// Age groups for adolescent\ncode "P0Y--P9Y": 'P0Y--P9Y' from "ISO-8601-Derived Periods" display '< 9 years'\ncode "P9Y--P14Y": 'P9Y--P14Y' from "ISO-8601-Derived Periods" display '9 - 14 years'\ncode "P15Y--P9999Y": 'P15Y--P9999Y' from "ISO-8601-Derived Periods" display '> 15 years'\n\n// RCV Startifiers\ncode "P0M--P9M": 'P0M--P9M' from "ISO-8601-Derived Periods" display '< 9 months'\ncode "P9M--P18M": 'P9M--P18M' from "ISO-8601-Derived Periods" display '9 - 18 months'\ncode "P18M--P15Y": 'P18M--P15Y' from "ISO-8601-Derived Periods" display '18 months - 15 years'\n\n// Varicella Age groups\ncode "P0M--P12M": 'P0M--P12M' from "ISO-8601-Derived Periods" display '< 12 months'\ncode "P12M--P18M": 'P12M--P18M' from "ISO-8601-Derived Periods" display '12 - 18 months'\ncode "P18M--P36M": 'P18M--P36M' from "ISO-8601-Derived Periods" display '18 - 36 months'\ncode "P36M--P12Y": 'P36M--P12Y' from "ISO-8601-Derived Periods" display '36 months - 12 years'\ncode "P12Y--P9999Y": 'P12Y--P9999Y' from "ISO-8601-Derived Periods" display '> 12 years'\n\n// Influenza Age Groups\ncode "P1Y--P15Y": 'P1Y--P15Y' from "ISO-8601-Derived Periods" display '1 year - 15 years'\ncode "P15Y--P60Y": 'P15Y--P60Y' from "ISO-8601-Derived Periods" display '15 years - 60 years'\ncode "P60Y--P9999Y": 'P60Y--P9999Y' from "ISO-8601-Derived Periods" display '> 60 years'\n\ncodesystem "Administrative Gender Codes": 'http://hl7.org/fhir/administrative-gender'\ncode "Males" : 'male' from "Administrative Gender Codes" display 'Males'\ncode "Females" : 'female' from "Administrative Gender Codes" display 'Females'\ncode "Other" : 'other' from "Administrative Gender Codes" display 'Other/NA'\ncontext Patient\n\n\n/** \n * Infant disaggregations by age\n */\ndefine "Newborn By Age Stratifier":\n case \n when AgeInHoursAt(start of "Measurement Period") <= 24 then "PT0H--PT24H"\n when AgeInWeeksAt(start of "Measurement Period") <= 2 then "PT24H--P2W"\n when AgeInWeeksAt(start of "Measurement Period") > 2 then "P2W--P9999Y"\n else null\n end\n\n/** \n * Infant disaggregations by age\n */\ndefine "Infant By Age Stratifier":\n case \n when AgeInYearsAt(start of "Measurement Period") < 1 then "P0Y--P1Y"\n when AgeInYearsAt(start of "Measurement Period") >= 1 then "P1Y--P9999Y"\n else null\n end\n\n/** \n * Toddler By Age Stratifiers\n */\ndefine "Toddler By Age Stratifier":\n case \n when AgeInYearsAt(start of "Measurement Period") < 1 then "P0Y--P1Y"\n when AgeInYearsAt(start of "Measurement Period") < 2 then "P1Y--P2Y"\n when AgeInYearsAt(start of "Measurement Period") >= 2 then "P2Y--P9999Y"\n else null\n end\n\n\n/** \n * Toddler By Age Stratifiers\n */\ndefine "Adolescent By Age Stratifier":\n case \n when AgeInYearsAt(start of "Measurement Period") < 9 then "P0Y--P9Y"\n when AgeInYearsAt(start of "Measurement Period") <= 14 then "P9Y--P14Y"\n when AgeInYearsAt(start of "Measurement Period") > 14 then "P15Y--P9999Y"\n else null\n end\n\n/** \n * RCV age disaggregators\n */\ndefine "RCV By Age Stratifier":\n case \n when AgeInMonthsAt(start of "Measurement Period") < 9 then "P0M--P9M"\n when AgeInMonthsAt(start of "Measurement Period") < 18 then "P9M--P18M"\n when AgeInYearsAt(start of "Measurement Period") < 15 then "P18M--P15Y"\n when AgeInYearsAt(start of "Measurement Period") >= 15 then "P15Y--P9999Y"\n else null\n end\n\n/** \n * Varicella age disaggregators\n */\ndefine "Varicella By Age Stratifier":\n case \n when AgeInMonthsAt(start of "Measurement Period") < 12 then "P0M--P12M"\n when AgeInMonthsAt(start of "Measurement Period") < 18 then "P12M--P18M"\n when AgeInMonthsAt(start of "Measurement Period") < 36 then "P18M--P36M"\n when AgeInYearsAt(start of "Measurement Period") < 12 then "P36M--P12Y"\n when AgeInYearsAt(start of "Measurement Period") >= 12 then "P12Y--P9999Y"\n else null\n end\n\n\n/** \n * Seasonal Influenza age disaggregators\n */\ndefine "Seasonal Influenza By Age Stratifier":\n case \n when AgeInYearsAt(start of "Measurement Period") < 1 then "P0Y--P1Y"\n when AgeInYearsAt(start of "Measurement Period") < 15 then "P1Y--P15Y"\n when AgeInYearsAt(start of "Measurement Period") < 60 then "P15Y--P60Y"\n when AgeInYearsAt(start of "Measurement Period") >= 60 then "P60Y--P9999Y"\n else null\n end\n\n/**\n * By Administrative Gender of Patient Stratifier\n */\ndefine "By Administrative Gender Stratifier":\n case \n when Patient.gender = 'male' then "Males"\n when Patient.gender = 'female' then "Females"\n else "Other"\n end\n\n/**\n * By Administrative Gender of Patient Stratifier\n */\ndefine "By Geographic Region Stratifier":\n First(Patient.address A where A.use in { 'home' }).state\n\n/** \n * @dataElement Patient is deceased\n */\ndefine "Patient Deceased During Measurement Period":\n case \n when Patient.deceased is FHIR.boolean then Patient.deceased as FHIR.boolean\n when Patient.deceased is FHIR.dateTime then Patient.deceased as FHIR.dateTime before end of "Measurement Period"\n else false\n end\n\n/** \n * Patient was born during measurement period\n */\ndefine "Patient Born During Measurement Period":\n Patient.birthDate during "Measurement Period"\n\n/** \n * Patient is < 12 months old at the end of the measurement period\n */\ndefine "Patient Under 12 Months Old During Measurement Period":\n Patient.birthDate more than 12 month before end of "Measurement Period"\n\n/** \n * Patient is < 12 years old at the end of the measurement period\n */\ndefine "Patient Under 2 Years Old During Measurement Period":\n Patient.birthDate more than 2 year before end of "Measurement Period"\n\n\n/** \n * @define Adverse events for immunizations which occurred during (or observed) during measurement period\n */\ndefine "Immunizations with Adverse Events During Measurement Period":\n IMMZCom."Doses Administered to Patient" I\n with [Observation: code in WC."Adverse Events"] O\n such that exists(I.reaction R where O.id = Last(Split(R.detail.reference, '/')))\n and FC.ToInterval(O.effective) during "Measurement Period"\n\n\n/** \n * @define Adverse events for immunizations which occurred during (or observed) during measurement period\n */\ndefine "Adverse Event Reactions During Measurement Period":\n [Observation: code in WC."Adverse Events"] O\n with IMMZCom."Doses Administered to Patient" I\n such that exists(I.reaction R where O.id = Last(Split(R.detail.reference, '/')))\n where FC.ToInterval(O.effective) during "Measurement Period"\n\n/** \n * @define Doses which were \n */\ndefine "Doses Administered to Patient During Measurement Period":\n IMMZCom."Doses Administered to Patient" I\n where IMMZCom.ToDate(I.occurrence) during "Measurement Period"\n\n/** \n * @function\n * @param immunization The immunization record for which the location should be retrieved\n * @return FHIR.address The location that the immunization event occurred\n */\ndefine function GetGeographicRegionForImmunization(immunization Immunization):\n WCom.Official([Location] L \n where L.id = Last(Split(immunization.location.reference, '/'))\n return L.address).state
Content not shown - (application/elm+xml, size = 118Kb)
Content not shown - (application/elm+json, size = 213Kb)
Related Artifacts
| depends-on | FHIR model information | http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 |
| depends-on | Library WCom | WHOCommon |
| depends-on | Library Wcon | WHOConcepts |
| depends-on | Library FHIRHelpers | http://fhir.org/guides/who/smart-immunization/Library/FHIRHelpers|4.0.1 |
| depends-on | Library FC | FHIRCommon |
| depends-on | Library IMMZc | IMMZConcepts |
| depends-on | Library IMMZcom | IMMZCommon |
| depends-on | Value set BCG Vaccine | http://fhir.org/guides/who/smart-immunization/ValueSet/IMMZ.A1.DE1 |
| depends-on | Value set Cholera Vaccine | http://fhir.org/guides/who/smart-immunization/ValueSet/IMMZ.A1.DE2 |
Parameters
| Get Medication | out | 0 | * | Medication |
| BCG Vaccine Codes | out | 0 | * | Medication |
| Cholera Vaccine Codes | out | 0 | * | Medication |
Data Requirements
Contents
text/cql
library IMMZVaccineLibrary\nusing FHIR version '4.0.1'\n\ninclude WHOCommon called WCom\ninclude WHOConcepts called Wcon\ninclude FHIRHelpers version '4.0.1'\ninclude FHIRCommon called FC\ninclude IMMZConcepts called IMMZc\ninclude IMMZCommon called IMMZcom\n\ndefine "Get Medication":\n [Medication]\n\ndefine "BCG Vaccine Codes":\n [Medication: code in IMMZc."BCG Vaccine"]\n \n\n /*check BCG Vaccine code valueset generated from DataDictionary Library in order to confirm that the that any of those codes exist in a Medication Resources\n 1. check for Medication Resource\n 2. Check if Medication Resource has BCG Vaccine code from list\n 3. Import that code into ActivityDefinition as defined by dynamicValue\n */\ndefine "Cholera Vaccine Codes":\n [Medication: code in IMMZc."Cholera Vaccine"]
Content not shown - (application/elm+xml, size = 6Kb)
Content not shown - (application/elm+json, size = 10Kb)
Related Artifacts
| depends-on | FHIR model information | http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 |
| depends-on | Library FHIRHelpers | http://fhir.org/guides/who/smart-immunization/Library/FHIRHelpers|4.0.1 |
| depends-on | Library FC | FHIRCommon |
Parameters
Data Requirements
Contents
text/cql
library WHOCommon\n\nusing FHIR version '4.0.1'\n\ninclude FHIRHelpers version '4.0.1'\n\ninclude FHIRCommon called FC\n\ncontext Patient\n\ndefine function Official(identifiers List<Identifier>):\n singleton from (identifiers I where I.use = 'official')\n\ndefine function Official(addresses List<Address>):\n singleton from (addresses A where A.use = 'official')\n\ndefine function Official(names List<HumanName>):\n singleton from (names N where N.use = 'official')\n\ndefine function Mobile(contactPoints List<ContactPoint>):\n singleton from (contactPoints P where P.use = 'mobile')\n\ndefine function Only(allergies List<AllergyIntolerance>):\n singleton from allergies\n\ndefine function Only(appointments List<Appointment>):\n singleton from appointments\n\ndefine function Only(careplans List<CarePlan>):\n singleton from careplans\n\ndefine function Only(conditions List<Condition>):\n singleton from conditions\n\ndefine function Only(encounters List<Encounter>):\n singleton from encounters\n\ndefine function Only(immunizations List<Immunization>):\n singleton from immunizations\n\ndefine function Only(medicationrequests List<MedicationRequest>):\n singleton from medicationrequests\n\ndefine function Only(observations List<Observation>):\n singleton from observations\n\ndefine function Only(procedures List<Procedure>):\n singleton from procedures\n\ndefine function Only(serviceRequests List<ServiceRequest>):\n singleton from serviceRequests\n\ndefine function Only(dosages List<Dosage>):\n singleton from dosages\n\ndefine function Only(doses List<FHIR.Dosage.DoseAndRate>):\n singleton from doses\n\ndefine function Earliest(observations List<Observation>):\n First(\n observations O\n sort by issued\n )\n\ndefine function Latest(observations List<Observation>):\n Last(\n observations O\n sort by issued\n )\n\ndefine function MostRecent(observations List<Observation>):\n Last(\n observations O\n sort by issued\n )\n\ndefine function MostRecent(procedures List<Procedure>):\n Last(\n procedures P\n sort by start of FC.ToInterval(performed)\n )\n\ndefine function Lowest(observations List<Observation>):\n First(\n observations O\n sort by (value as FHIR.Quantity)\n )\n\ndefine function Highest(observations List<Observation>):\n Last(\n observations O\n sort by (value as FHIR.Quantity)\n )\n\n/*\n@description: Returns any WHO core extensions defined on the given resource with the specified id.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the\nCQL model info.\n*/\ndefine function Extensions(domainResource DomainResource, id String):\n domainResource.extension E\n\t where E.url = ('http://fhir.org/guides/who/core/StructureDefinition/' + id)\n\t\treturn E\n\n/*\n@description: Returns the single WHO core extension (if present) on the given resource with the specified id.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified id.\n*/\ndefine function Extension(domainResource DomainResource, id String):\n singleton from "Extensions"(domainResource, id)\n\n/*\n@description: Returns any WHO core extensions defined on the given element with the specified id.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the CQL model info.\n*/\ndefine function Extensions(element Element, id String):\n element.extension E\n\t where E.url = ('http://fhir.org/guides/who/core/StructureDefinition/' + id)\n\t\treturn E\n\n/*\n@description: Returns the single WHO core extension (if present) on the given element with the specified id.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function Extension(element Element, id String):\n singleton from Extensions(element, id)\n\n/*\n@description: Returns any WHO core modifier extensions defined on the given resource with the specified id.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the\nCQL model info.\n*/\ndefine function ModifierExtensions(domainResource DomainResource, id String):\n domainResource.modifierExtension E\n\t where E.url = ('http://fhir.org/guides/who/core/StructureDefinition/' + id)\n\t\treturn E\n\n/*\n@description: Returns the single WHO core modifier extension (if present) on the given resource with the specified id.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function ModifierExtension(domainResource DomainResource, id String):\n singleton from ModifierExtensions(domainResource, id)\n\n/*\n@description: Returns any WHO core modifier extensions defined on the given element with the specified id.\n@comment: NOTE: Extensions are not the preferred approach, but are used as a way to access\ncontent that is defined by extensions but not yet surfaced in the CQL model info.\n*/\ndefine function ModifierExtensions(element BackboneElement, id String):\n element.modifierExtension E\n\t where E.url = ('http://fhir.org/guides/who/core/StructureDefinition/' + id)\n\t\treturn E\n\n/*\n@description: Returns the single WHO core modifier extension (if present) on the given element with the specified id.\n@comment: This function uses singleton from to ensure that a run-time exception is thrown if there\nis more than one extension on the given resource with the specified url.\n*/\ndefine function ModifierExtension(element BackboneElement, id String):\n singleton from ModifierExtensions(element, id)\n
Content not shown - (application/elm+xml, size = 74Kb)
Content not shown - (application/elm+json, size = 131Kb)
Related Artifacts
Contents
text/cql
library WHOConcepts\n\n// Code Systems\ncodesystem "ICD-10": 'http://hl7.org/fhir/sid/icd-10'\ncodesystem "SNOMED-CT": 'http://snomed.info/sct'\ncodesystem "LOINC": 'http://loinc.org'\ncodesystem "RxNorm": 'http://www.nlm.nih.gov/research/umls/rxnorm'\ncodesystem "CIEL": 'http://hl7.org/fhir/sid/ciel'\ncodesystem "ICD-11": 'http://hl7.org/fhir/sid/icd-11'\ncodesystem "ICHI": 'https://mitel.dimi.uniud.it/ichi/#http://id.who.int/ichi'\ncodesystem "ICF": 'http://hl7.org/fhir/sid/icf-nl'\ncodesystem "Extended Codes CodeSystem codes": 'http://fhir.org/guides/who/anc-cds/CodeSystem/anc-custom-codes'\n\n// ValuSets\nvalueset "Pregnancy Status Pregnant": 'http://fhir.org/guides/who/core/ValueSet/pregnancystatus-values'\nvalueset "Adverse Events": 'http://hl7.org/fhir/ValueSet/adverse-event-type'\n
Content not shown - (application/elm+xml, size = 4Kb)
Content not shown - (application/elm+json, size = 6Kb)
Generated Narrative: Measure
url: http://fhir.org/guides/who/smart-immunization/Measure/IMMZIND05
version: 0.1.0
name: IMMZIND05
status: draft
experimental: false
date: 2023-10-05
publisher: World Health Organization (WHO)
contact: World Health Organization (WHO): https://www.who.int
description: IMMZ.IND.05 Measles indicator for first dose.
jurisdiction: Global (Whole world) (m49.htm#001)
library: IMMZINDMeasles
scoring: Continuous Variable (MeasureScoring#continuous-variable)
group
population
id
IMMZ.IND.05.IP
CQFM Population Basis: boolean
code: Initial Population (MeasurePopulationType#initial-population)
description: Initial Population
Criteria
| - | Language | Expression |
| * | text/cql | Initial Population 05 |
population
id
IMMZ.IND.05.MP
CQFM Population Basis: boolean
code: Measure Population (MeasurePopulationType#measure-population)
description: Measure Population
Criteria
| - | Language | Expression |
| * | text/cql | Measure Population 05 |
population
id
IMMZ.IND.05.MO
CQFM Criteria Reference: measure-population
CQFM Aggregate Method: count
code: Measure Observation (MeasurePopulationType#measure-observation)
description: Measure Observation
Criteria
| - | Language | Expression |
| * | text/cql | Measure Observation 05 |
stratifier
id
IMMZ.IND.05.S
Criteria
| - | Language | Expression |
| * | text/cql | Stratification |
Generated Narrative: Measure
url: http://fhir.org/guides/who/smart-immunization/Measure/IMMZIND40
version: 0.1.0
name: IMMZIND40
status: draft
experimental: false
date: 2023-10-05
publisher: World Health Organization (WHO)
contact: World Health Organization (WHO): https://www.who.int
description: IMMZ.IND.40 Measles indicator for second dose.
jurisdiction: Global (Whole world) (m49.htm#001)
library: IMMZINDMeasles
scoring: Continuous Variable (MeasureScoring#continuous-variable)
group
population
id
IMMZ.IND.40.IP
CQFM Population Basis: boolean
code: Initial Population (MeasurePopulationType#initial-population)
description: Initial Population
Criteria
| - | Language | Expression |
| * | text/cql | Initial Population 40 |
population
id
IMMZ.IND.40.MP
CQFM Population Basis: boolean
code: Measure Population (MeasurePopulationType#measure-population)
description: Measure Population
Criteria
| - | Language | Expression |
| * | text/cql | Measure Population 40 |
population
id
IMMZ.IND.40.MO
CQFM Criteria Reference: measure-population
CQFM Aggregate Method: count
code: Measure Observation (MeasurePopulationType#measure-observation)
description: Measure Observation
Criteria
| - | Language | Expression |
| * | text/cql | Measure Observation 40 |
stratifier
id
IMMZ.IND.40.S
Criteria
| - | Language | Expression |
| * | text/cql | Stratification |
Generated Narrative: PlanDefinition
CPG Knowledge Capability Extension: computable
url: http://fhir.org/guides/who/smart-immunization/PlanDefinition/IMMZD2DTMeasles
version: 0.1.0
name: IMMZD2DTMeasles
title: IMMZ.D2.DT.Measles
type: ECA Rule (PlanDefinitionType#eca-rule)
status: draft
experimental: false
date: 2023-10-12 09:43:25-0400
publisher: World Health Organization (WHO)
contact: World Health Organization (WHO): https://www.who.int
description: If the child or patient has not been given MCV1 (at 9 months) and MCV2 (between 15-18 months) vaccination
jurisdiction: Global (Whole world) (m49.htm#001)
library: IMMZD2DTMeasles
action
title: Immunize patient for Measles
description: Provide measles immunization
condition
kind: applicability
Expressions
| - | Description | Language | Expression |
| * | Provision of the MCV dose | text/cql-identifier | Provision of the MCV dose |
definition: IMMZ.D2.DT.Measles.MR
Generated Narrative: PlanDefinition
CPG Knowledge Capability Extension: computable
url: http://fhir.org/guides/who/smart-immunization/PlanDefinition/IMMZDTUmbrella
version: 0.1.0
name: IMMZDTUmbrella
title: IMMZ.DT.Umbrella
type: Workflow Definition (PlanDefinitionType#workflow-definition)
status: draft
experimental: false
date: 2023-10-12 09:43:25-0400
publisher: World Health Organization (WHO)
contact: World Health Organization (WHO): https://www.who.int
description: If the child or patient has not been given MCV1 (at 9 months) and MCV2 (between 15-18 months) vaccination
jurisdiction: Global (Whole world) (m49.htm#001)
action
title: Check Immunizations
description: Check immunization plan definitions to see what is required.
code: Dispense Medications (CPG Common Process Code System#dispense-medications)
selectionBehavior: all
Actions
| LinkId | Text | Cardinality | Type | Description & Constraints![\"doco\"](\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\") |
|---|
![\".\"](\"tbl_spacer.png\") ![\".\"](\"icon_q_root.gif\" "\\"QuestionnaireRoot\\"") | Immunization - Capture Client History Questionnaire | | Questionnaire | http://fhir.org/guides/who/smart-immunization/Questionnaire/Questionnaire-IMMZD1ClientHistory#0.1.0 |
\r\n![\".\"](\"tbl_vjoin.png\") ![\".\"](\"icon-q-boolean.png\" "\\"Boolean\\"") dose0 | Indicates if the client has received a birth dose and/or supplementary dose | 0..1 | boolean | |
\r\n| completedPrimarySeries | Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen. | 0..1 | boolean | |
\r\n![\".\"](\"icon-q-date.png\" "\\"Date\\"") dateSeriesCompleted | The date when the client completed the primary vaccination series - per product/antigen | 0..* | date | |
\r\n![\".\"](\"icon-q-coding.png\" "\\"Coding\\"") hivStatus | The current human immunodeficiency virus HIV status of the client | 0..1 | choice | Value Set: IMMZ.D1.DE10 ValueSet for HIV Status |
\r\n| immunocompromised | The client is known to be immunocompromised or immunosuppressed. This means the client has a weakened immune system and having a reduced ability to fight infections and other diseases | 0..1 | boolean | |
\r\n| onART | The client is currently receiving antiretroviral therapy ART | 0..1 | boolean | |
\r\n| hivExposedInfant | The infant is known to be exposed to HIV, i.e. born to an HIV-infected woman | 0..* | boolean | |
\r\n| immuneReconstitutionAchieved | The client is known to have achieved immune reconstitution | 0..* | boolean | |
\r\n| severelyImmunosuppressed | The client is known to be severely immunocompromised or immunosuppressed | 0..* | boolean | |
\r\n![\".\"](\"tbl_vjoin_end.png\") artStartDate | The date on which the client started or restarted antiretroviral therapy ART | 0..* | date | |
\r\n
Documentation for this format |
| LinkId | Text | Definition | Answer |
|---|
| Example.IMMZ.C.QuestionnaireResponse.1 | | | Questionnaire:Client Registration Questionnaire |
\r\n![\".\"](\"icon-q-string.png\" "\\"Item\\"") uniqueId | Unique identifier for the client | | 123456 |
\r\n![\".\"](\"icon-q-group.png\" "\\"Group\\"") name | Client name | | |
\r\n![\".\"](\"tbl_vline.png\") fullName | Full name of the client | | Test Patient |
\r\n| firstName | First or given name | | Test |
\r\n| familyName | Family name | | Patient |
\r\n| sex | Sex | | IMMZ.C CodeSystem for Data Elements DE6: Male |
\r\n| birthDate | Birth Date | | 1993-08-12 |
\r\n| ageInWeeks | Age in Weeks | | 1565 |
\r\n| ageInMonths | Age in Months | | 359 |
\r\n| ageInYears | Age in Years | | 29 |
\r\n| caregiver | Care giver name | | |
\r\n| fullName | Full name of the care giver | | Mother Patient |
\r\n| firstName | First or given name | | Mother |
\r\n| familyName | Family name | | Patient |
\r\n| caregiver | Care giver name | | |
\r\n| fullName | Full name of the care giver | | Father Patient |
\r\n| firstName | First or given name | | Father |
\r\n| familyName | Family name | | Patient |
\r\n| phone | Client Phone number | | 406-555-1212 |
\r\n| administrativeArea | Administrative Area | | ISO 3166 Part 2 Country Subdivision Codes KE-30: Nairobi City |
\r\n| healthWorker | Health Worker | | false |
\r\n
Documentation for this format |
\r\nmap "http://fhir.org/guides/who/smart-immunization/StructureMap/IMMZCLMToPatient" = "IMMZCLMToPatient"\r\n\r\nuses "http://fhir.org/guides/who/smart-immunization/StructureDefinition/IMMZCRegisterClient" alias IMMZC as source\r\nuses "http://hl7.org/fhir/StructureDefinition/Patient" alias Patient as target\r\n\r\ngroup IMMZCToPatient(source immzc : IMMZC, target patient : Patient) {\r\n immzc.uniqueId as id -> patient.identifier as identifier then {\r\n id -> identifier.value = id "SetIdentifierValue";\r\n } "SetIdentifier";\r\n immzc -> patient.name as pname then NameToHumanName(immzc, pname) "SetName";\r\n immzc.sex as sex -> patient.gender = translate(sex, 'http://fhir.org/guides/who/smart-immunization/ConceptMap/IMMZ.C.SexToAdministrativeGender', 'code') "SetGender";\r\n immzc.birthDate as birthDate -> patient.birthDate = birthDate "SetBirthDate";\r\n immzc.caregiver as caregiver -> patient.contact as contact, contact.name as hname then NameToHumanName(caregiver, hname) "SetCaregiver";\r\n immzc.phone as phone -> patient.telecom as telecom then {\r\n phone as content -> telecom.value = content, telecom.system = 'phone' "SetPhoneValue";\r\n } "SetPhone";\r\n immzc.administrativeArea as area -> patient.address as address then {\r\n area.coding first as coding -> address then {\r\n coding.code as content -> address.text = content "SetAddressToCode";\r\n coding.display as content -> address.text = content "SetAddressToDisplay";\r\n } "SetAddressText";\r\n } "SetAdministrativeArea";\r\n}\r\n\r\ngroup NameToHumanName(source immzc, target hname) {\r\n immzc.name as fullName -> hname.text = fullName "SetFullName";\r\n immzc.firstName as firstName -> hname.given = firstName "SetFirstName";\r\n immzc.familyName as familyName -> hname.family = familyName "SetFamilyName";\r\n}\r\n\r\n\r\nmap "http://fhir.org/guides/who/smart-immunization/StructureMap/IMMZCQRToLM" = "IMMZCQRToLM"\r\n\r\nuses "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" alias QResp as source\r\nuses "http://fhir.org/guides/who/smart-immunization/StructureDefinition/IMMZCRegisterClient" alias IMMZC as target\r\n\r\ngroup QRespToIMMZC(source qr : QResp, target immzc : IMMZC) {\r\n qr.item as item then {\r\n item.answer first as answer where item.linkId = 'uniqueId' then {\r\n answer.value as content -> immzc.uniqueId = content "SetIdentifier";\r\n } "FirstAnswerForIdentifier";\r\n item where item.linkId = 'name' then NameToIMMZC(item, immzc) "SetNames";\r\n item where item.linkId = 'caregiver' -> immzc.caregiver as caregiver then NameToIMMZC(item, caregiver) "SetNames";\r\n item.answer first as answer where item.linkId = 'sex' then {\r\n answer.value as coding then {\r\n coding.code as content -> immzc.sex = content "SetSex";\r\n } "ProcessCoding";\r\n } "FirstAnswerForIdentifier";\r\n item.answer first as answer where item.linkId = 'birthDate' then {\r\n answer.value as content -> immzc.birthDate = content "SetBirthDate2";\r\n } "FirstAnswerForBirthDate";\r\n item.answer as caregiver where item.linkId = 'caregiver' -> immzc.caregiver as caretgt then NameToIMMZC(caregiver, caretgt) "SetCaregiver";\r\n item.answer first as answer where item.linkId = 'phone' then {\r\n answer.value as content -> immzc.phone = content "SetPhone";\r\n } "FirstAnswerForPhone";\r\n item.answer first as answer where item.linkId = 'administrativeArea' then {\r\n answer.value as coding -> immzc.administrativeArea as area then {\r\n coding -> area.coding = coding "SetCodingValue";\r\n coding.display as display -> area.text = display "SetDisplay";\r\n } "SetCoding";\r\n } "FirstAnswerForAdministrativeArea";\r\n item.answer first as answer where item.linkId = 'healthWorker' then {\r\n answer.value as content -> immzc.healthWorker = content "SetHealthWorker";\r\n } "FirstAnswerForHealthWorker";\r\n } "processItems";\r\n}\r\n\r\ngroup NameToIMMZC(source name, target immzc) {\r\n name.item as item then {\r\n item.answer first as answer where item.linkId = 'fullName' then {\r\n answer.value as content -> immzc.name = content "SetFullName";\r\n } "FirstAnswerForFullName";\r\n item.answer first as answer where item.linkId = 'firstName' then {\r\n answer.value as content -> immzc.firstName = content "SetFirstName";\r\n } "FirstAnswerForFirstName";\r\n item.answer first as answer where item.linkId = 'familyName' then {\r\n answer.value as content -> immzc.familyName = content "SetFamilyName";\r\n } "FirstAnswerForFamilyName";\r\n } "processNameItems";\r\n}\r\n\r\n- Include these codes as defined in
http://snomed.info/sct| Code | Display |
| 713540004 | Substance with antiretroviral mechanism of action (substance) |
| 788075003 | Medicinal product acting as antiretroviral agent (product) |
This value set includes codes based on the following rules:
This value set includes codes based on the following rules:
- Include these codes as defined in
http://snomed.info/sct| Code | Display |
| 278977008 | Human immunodeficiency virus status (observable entity) |
- Include these codes as defined in
http://hl7.org/fhir/sid/icd-11| Code | Display |
| 1C62.Z | Human immunodeficiency virus disease without mention of associated disease or condition, clinical stage unspecified |
| MA14.0 | Laboratory evidence of human immunodeficiency virus |
This value set includes codes based on the following rules:
- Include these codes as defined in
http://www.whocc.no/atc| Code | Display |
| J07BD53 | measles, combinations with rubella, live attenuated |
| J07BD54 | measles, combinations with mumps, rubella and varicella, live attenuated |
| J07BD | Measles vaccines |
| J07BD52 | measles, combinations with mumps and rubella, live attenuated |
| J07BD01 | measles, live attenuated |
| J07BD51 | measles, combinations with mumps, live attenuated |
- Include these codes as defined in
http://snomed.info/sct| Code | Display |
| 440075005 | Live measles + rubella vaccine injection dose form (product) |
| 419550004 | Measles + mumps + rubella + varicella vaccine (product) |
| 386012008 | Measles vaccine (product) |
| 400449000 | Measles virus vaccine, live, 0.5mL/vial powder for injection (product) |
| 61153008 | Measles, mumps and rubella vaccine (product) |
| 347649008 | Measles/mumps/rubella vaccine powder and solvent for injection solution vial (product) |
| 419771007 | Measles/mumps/rubella/varicella vaccine powder and solvent for injection solution vial (product) |
- Include these codes as defined in
ICD-11| Code | Display |
| XM28X5 | Measles vaccines |
- Include these codes as defined in
http://loinc.org| Code | Display |
| 30940-1 | Measles virus+Mumps virus+Rubella virus dose count in combination vaccine |
- Include these codes as defined in
http://fhir.org/guides/who/smart-immunization/CodeSystem/IMMZ.D1| Code | Display | Definition |
| DE53 | Inactivated Vero cell-derived vaccine | Inactivated Vero cell-derived Japanese encephalitis (JE) vaccine type |
| DE54 | Live attenuated vaccine | Live attenuated Japanese encephalitis (JE) vaccine type |
| DE55 | Live recombinant vaccine | Live recombinant Japanese encephalitis (JE) vaccine type |
- Include these codes as defined in
http://fhir.org/guides/who/smart-immunization/CodeSystem/IMMZ.D1| Code | Display | Definition |
| DE57 | FSME-Immun | FSME-Immun vaccine product, which is an inactivated whole-virus vaccine for tick-borne encephalitis (TBE) |
| DE58 | Encepur | Encepur vaccine product, which is an inactivated viral vaccine for tick-borne encephalitis (TBE) |
| DE59 | TBE-Moscow | TBE-Moscow vaccine product, which is a vaccine for tick-borne encephalitis (TBE) |
| DE60 | EnceVir | EnceVir vaccine product, which is a vaccine for tick-borne encephalitis (TBE) |
- Include these codes as defined in
http://fhir.org/guides/who/smart-immunization/CodeSystem/IMMZ.D4| Code | Display | Definition |
| DE162 | Currently pregnant | The client is currently pregnant |
| DE165 | Severely immunosuppressed | The client is known to be severely immunocompromised or immunosuppressed |
| DE166 | History of anaphylactic reactions | The client is known to have history of anaphylaxis in the past. Anaphylaxis is a severe and potentially life-threatening allergic reaction that can occur rapidly after exposure to an allergen or vaccine component. |
| DE167 | Severe allergic reactions | The client is known to have severe allergic reaction to vaccine |
| DE168 | Symptomatic HIV infection | The client is experiencing HIV-related symptoms |
- Include these codes as defined in
http://hl7.org/fhir/sid/icd-11| Code | Display |
| XM8142 | |
| XM72A0 | |
| XM47S0 | |
| XM8L15 | |
| XM8TF3 | |
| XM21H2 | |
| XM4AJ8 | |
| XM9439 | |
| XM2340 | |
| XM79H3 | |
| XM0VX8 | |
| XM0KZ1 | |
| XM4GV0 | |
| XM9PS9 | |
| XM3B09 | |
| XM5V64 | |
| XM33K4 | |
| XM0NS8 | |
| XM3418 | |
| XM5DF6 | |
- Include these codes as defined in
http://terminology.hl7.org/CodeSystem/condition-clinical| Code | Display | Definition |
| active | Active | The subject is currently experiencing the condition or situation, there is evidence of the condition or situation, or considered to be a significant risk. |
| recurrence | Recurrence | The subject is experiencing a reoccurence or repeating of a previously resolved condition or situation, e.g. urinary tract infection, food insecurity. |
| relapse | Relapse | The subject is experiencing a return of a condition or situation after a period of improvement or remission, e.g. relapse of cancer, alcoholism. |
SNOMED CT Clinical Findings
This value set includes all SNOMED CT Clinical Findings.
\n
Copyright Statement:
This resource includes content from SNOMED Clinical Terms® (SNOMED CT®) which is copyright of the International Health Terminology Standards Development Organisation (IHTSDO). Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact http://www.snomed.org/snomed-ct/get-snomed-ct or info@snomed.org
\n
This value set includes codes from the following code systems:
This value set contains 1 concepts
| Code | System | Display |
| \u00a0\u00a0ANC.B9.DE45 | http://fhir.org/guides/who/anc-cds/CodeSystem/anc-custom-codes | HIV status |
This value set contains 1 concepts
| Code | System | Display |
| \u00a0\u00a0ANC.B9.DE46 | http://fhir.org/guides/who/anc-cds/CodeSystem/anc-custom-codes | HIV positive |
This value set contains 1 concepts
| Code | System | Display |
| \u00a0\u00a0ANC.B9.DE47 | http://fhir.org/guides/who/anc-cds/CodeSystem/anc-custom-codes | HIV negative |
This value set includes codes based on the following rules:
This value set includes codes based on the following rules:
- Include these codes as defined in
http://who.int/cg/CodeSystem/extended-content| Code | Display |
| Don't know | Don't know |
| STI medication | STI medication |
| Other Antibiotics | Other antibiotics |
| Other | Other (specify) |
- Include these codes as defined in
http://snomed.info/sct
This value set includes codes based on the following rules:
- Include these codes as defined in
http://snomed.info/sct - Include these codes as defined in
http://loinc.org - Include these codes as defined in
http://www.nlm.nih.gov/research/umls/rxnorm| Code | Display |
| 3127785 | Levonorgestrel IUD (LNG-IUD) |
| 393401 | Etonogestrel (ETG) one-rod implant |
| 646249 | Etonogestrel (ETG) one-rod implant |
| 710529 | Combined contraceptive vaginal ring (CVR) |
| 2109022 | Progesterone-releasing vaginal ring (PVR) |
- Include these codes as defined in
http://who.int/cg/CodeSystem/extended-content| Code | Display |
| Levonorgestrel (LNG) two-rod implant | Levonorgestrel (LNG) two-rod implant |
- Include these codes as defined in
http://hl7.org/fhir/sid/icd-10| Code | Display |
| Z30.49 | Female condom |
This value set includes codes based on the following rules:
This value set includes codes based on the following rules:
- Include these codes as defined in
http://terminology.hl7.org/CodeSystem/v3-EducationLevel| Code | Display | Definition |
| HS | High School | High School or secondary school degree complete |
| ELEM | Elementary education | Elementary School |
- Include these codes as defined in
http://who.int/cg/CodeSystem/extended-content| Code | Display |
| NONE | No education |
This value set includes codes based on the following rules:
- Include these codes as defined in
http://terminology.hl7.org/CodeSystem/condition-clinical| Code | Display | Definition |
| inactive | Inactive | The subject is no longer experiencing the condition or situation and there is no longer evidence or appreciable risk of the condition or situation. |
| remission | Remission | The subject is not presently experiencing the condition or situation, but there is a risk of the condition or situation returning. |
| resolved | Resolved | The subject is not presently experiencing the condition or situation and there is a negligible perceived risk of the condition or situation returning. |
- Include these codes as defined in
http://terminology.hl7.org/CodeSystem/v3-MaritalStatus| Code | Display | Definition |
| U | Unmarried | Currently not in a marriage contract. |
| M | Married | A current marriage contract is active |
| D | Divorced | Marriage contract has been declared dissolved and inactive |
| W | Widowed | The spouse has died |
| UNK | Unknown | |
This value set includes codes based on the following rules:
This value set includes codes based on the following rules:
This value set includes codes based on the following rules:
This value set includes codes based on the following rules:
- Include these codes as defined in
http://loinc.org - Include these codes as defined in
http://snomed.info/sct - Include these codes as defined in
http://hl7.org/fhir/sid/icd-10| Code | Display |
| T38.4 | Side effects from contraception |
| Z76.89 | Out of stock |
| Z31.9 | Sterile for non-contraceptive reasons |
- Include these codes as defined in
http://who.int/cg/CodeSystem/extended-content
This value set includes codes based on the following rules:
- Include these codes as defined in
http://snomed.info/sct - Include these codes as defined in
http://who.int/cg/CodeSystem/extended-content| Code | Display |
| Other | Other (specify) |
- Include these codes as defined in
http://who.int/cg/CodeSystem/extended-content| Code | Display |
| G | Government |
| I | Insurance |
This value set includes codes based on the following rules:
This value set includes codes based on the following rules:
This value set includes codes based on the following rules:
This value set includes codes based on the following rules:
- Include these codes as defined in
http://who.int/cg/CodeSystem/extended-content| Code | Display |
| Community | Community |
| Facility | Facility |
- Include these codes as defined in
http://snomed.info/sct
This value set includes codes based on the following rules:
- Include these codes as defined in
http://snomed.info/sct - Include these codes as defined in
http://hl7.org/fhir/sid/icd-10| Code | Display |
| Z20.6 | Sex with HIV+ person |
| z13.9 | Referral for STI screening |
| Z72.51 | Patient with multiple sexual partners |
| Z72.52 | Patient with multiple sexual partners |
| Z72.53 | Patient with multiple sexual partners |
This value set includes codes based on the following rules:
- Include these codes as defined in
http://who.int/cg/CodeSystem/extended-content| Code | Display |
| Returning Client | Returning client |
| Referral | Referral |
| New Client | New client |
| First visit for symptoms | First visit for symptoms |
| STI Follow up | Follow up for STI management |
- Include these codes as defined in
http://terminology.hl7.org/CodeSystem/v2-0276| Code | Display | Definition |
| FOLLOWUP | Follow up appointment | A follow up visit from a previous appointment |
WHO ATC - IPS
World Health Organization Anatomical Therapeutic Chemical (ATC) classification system. Note: The currently implemented code system and the value set expansion contain only a set of example ATC codes, not the complete code system content.
\n
Copyright Statement: This artifact includes content from Anatomical Therapeutic Chemical (ATC) classification system. ATC codes are copyright World Health Organization (WHO) Collaborating Centre for Drug Statistics Methodology. Terms & Conditions in https://www.whocc.no/use_of_atc_ddd/
![\".\"](\"icon_element.gif\" "\\"Element\\"")
![\".\"](\"icon_primitive.png\" "\\"Primitive")
![\".\"](\"icon_datatype.gif\" "\\"Data")
![\".\"](\"icon_extension_simple.png\" "\\"Simple")
![\".\"](\"icon_fixed.gif\" "\\"Fixed")