hl7.fhir.us.vr-common-library
Install package
npm install --registry https://fs.get-ig.org/pkgs hl7.fhir.us.vr-common-libraryGet resources
curl https://fs.get-ig.org/rs/hl7.fhir.us.vr-common-library-2.0.0.ndjson.gz | gunzip | jq '{url,resourceType,version, id}'{
"fhirVersions": [ "4.0.1" ],
"tools-version": 3,
"_id": "hl7.fhir.us.vr-common-library@2.0.0",
"date": "20241011180339",
"license": "CC0-1.0",
"jurisdiction": "urn:iso:std:iso:3166#US",
"dist": {
"tarball": "https://fs.get-ig.org/-/hl7.fhir.us.vr-common-library-2.0.0.tgz"
},
"name": "hl7.fhir.us.vr-common-library",
"dist-tags": {
"latest": "2.0.0"
},
"type": "IG",
"title": "Vital Records Common Library (VRCL) FHIR Implementation Guide",
"author": "HL7 International / Public Health",
"_versions": [ "2.0.0", "2.0.0-ballot", "1.1.0", "1.0.0", "0.1.0" ],
"id": "hl7.fhir.us.vr-common-library@2.0.0",
"directories": {
"lib": "package",
"example": "example"
},
"canonical": "http://hl7.org/fhir/us/vr-common-library",
"url": "http://hl7.org/fhir/us/vr-common-library/STU2",
"versions": {
"1.1.0": {
"description": "### Description\n\nThis guide is a Fast Healthcare Interoperability Resources (FHIR) Profiles Library to support the needs of multiple vital records implementation guides (IGs). It does not provide any use case (scenario) specific content or additional guidance on how to use these artifacts, but serves as a source for a standard set of profiles for reuse in multiple use case specific IGs focusing on the exchange of vital records information. Implementation details such as how and when to use a given artifact will be supplied in these guides.\n\n### Background\nTwo FHIR IG projects, [Birth Defects](https://www.hl7.org/special/Committees/projman/searchableProjectIndex.cfm?action=edit&ProjectNumber=1532) and [Birth and Fetal Death Reporting](http://hl7.org/fhir/us/bfdr/), share many common data elements or concepts. The initial scope of this Vital Records Common Profiles Library included data elements common to these two FHIR projects in a US Realm framework. The current update adds data elements shared by two other vital records FHIR IGs, [Vital Records Death Reporting (VRDR)](http://hl7.org/fhir/us/vrdr/), and the [Medicolegal Death Investigation (MDI)](http://hl7.org/fhir/us/mdi/).\n\nMany of the data elements in the vital records IGs (BFDR, VRDR, and this Library) can be identified using the IJE (Inter-Jurisdictional Exchange) data element names (codes). The IJE codes are used for exchange of data among jurisdictions and with authorized data partners, such as NCHS. NCHS has implemented IJE codes for exchange of mortality data with jurisdictions via the VRDR IG, however, the use of IJE codes has not yet been implemented for birth and fetal death reporting to NCHS. [FHIR profile mappings to the IJE format are available for Mortality, Natality, and Fetal Death.](https://github.com/HL7/vr-common-library/raw/master/input/mapping/IJE_File_Layouts_Version_2021_FHIR-2023-02-22-All-Combined.xlsx) The mappings are based on information from: \n * [200X NCHS Mortality - Demographic File Description](https://www.cdc.gov/nchs/data/dvs/200XMOR_web_with%20clearance%20revisions-acc.pdf)\n * [200X NCHS Natality File Description](https://www.cdc.gov/nchs/data/dvs/200XNAT_web_with%20clearance%20revisions-acc.pdf)\n * [200X NCHS Fetal Death File Description](https://www.cdc.gov/nchs/data/dvs/200XFET_web_with%20clearance%20revisions-acc.pdf)\n\nA FHIR common profiles library avoids defining the same data element multiple times across IGs by allowing each IG to reference them. This profile library will provide a standard framework for vital records information to support interoperability among public health systems and reduce provider and implementer burden. This FHIR IG uses US Core profiles. Where unable to use a US Core profile, we have followed the Cross-Group Projects Work Group's variance request process and have provided the US Realm Steering Committee an approved rationale for deviation in the IG.\n\nFor Clinical Safety Information please refer to the [FHIR Implementer’s Safety Checklist](http://hl7.org/fhir/safety.html).\n\n### How to Read This Guide\nThis Guide is divided into several pages which are listed at the top of each page in the menu bar.\n\n* Home: The introduction and background for HL7® FHIR® Vital Records Common Profiles Library\n* [Terminology](terminology.html): A listing of the value sets used in this guide\n* [Downloads](downloads.html): Links to downloadable artifacts\n* [Change Log](change_log.html): Details of changes made in each version of this IG\n* [Artifact Index](artifacts.html): A list of the defined FHIR artifacts (profiles, examples, and value sets) in this guide (built Fri, Oct 6, 2023 12:58+0000+00:00)",
"fhirVersions": [ "4.0.1" ],
"tools-version": 3,
"_id": "hl7.fhir.us.vr-common-library@1.1.0",
"date": "20231006125829",
"license": "CC0-1.0",
"dist": {
"tarball": "https://fs.get-ig.org/-/hl7.fhir.us.vr-common-library-1.1.0.tgz"
},
"name": "hl7.fhir.us.vr-common-library",
"type": "IG",
"title": "Vital Records Common Profiles Library",
"author": "HL7 International / Public Health",
"id": "hl7.fhir.us.vr-common-library@1.1.0",
"directories": {
"lib": "package",
"example": "example"
},
"canonical": "http://hl7.org/fhir/us/vr-common-library",
"url": "http://hl7.org/fhir/us/vr-common-library/STU1.1",
"version": "1.1.0",
"maintainers": [ {
"url": "http://www.hl7.org/Special/committees/pher",
"name": "HL7 International / Public Health"
} ],
"dependencies": {
"us.cdc.phinvads": "0.12.0",
"hl7.fhir.r4.core": "4.0.1",
"hl7.fhir.us.core": "5.0.1",
"hl7.fhir.us.vrdr": "2.1.0",
"hl7.terminology.r4": "5.3.0",
"hl7.fhir.uv.extensions": "1.0.0"
}
},
"0.1.0": {
"description": "The purpose of this project is to create an HL7 Fast Healthcare Interoperability Resources (FHIR) Library standard to support the needs of multiple Vital Records Implementation Guides.\n\nAfter evaluation and analysis of two separate FHIR IG projects - [Birth Defects Reporting](https://build.fhir.org/ig/HL7/fhir-birthdefectsreporting-ig/) and [Birth and Fetal Death Reporting](http://build.fhir.org/ig/HL7/fhir-bfdr), it was determined that there are many common data elements between the two IGs. The short-term scope of this common profiles library will include data elements common to the above-mentioned FHIR IGs and will define a US Realm specific framework that defines common elements for the implementation guides. The longer-term scope of this profiles library will include analysis and possible inclusion of data elements from other Vital Records projects (such as [Vital Records Mortality and Morbidity Reporting FHIR IG](https://build.fhir.org/ig/HL7/vrdr/)).\n\nTo avoid defining the same profiles multiple times, we propose to create a US Realm focused profile library for use by Vital Records and other FHIR standards development efforts to define the appropriate FHIR profiles, value sets, etc., once and allow them to be referenced by each of the specific implementation guides. This profile library will provide a standard framework for inclusion in multiple use case specific implementation guides focused on the exchange of Vital Records information to support interoperability among public health systems and reduce provider and implementer burden. (built Wed, Dec 16, 2020 17:44+0000+00:00)",
"fhirVersions": [ "4.0.1" ],
"tools-version": 3,
"_id": "hl7.fhir.us.vr-common-library@0.1.0",
"date": "20201216174420",
"license": "CC0-1.0",
"jurisdiction": "urn:iso:std:iso:3166#US",
"dist": {
"tarball": "https://fs.get-ig.org/-/hl7.fhir.us.vr-common-library-0.1.0.tgz"
},
"name": "hl7.fhir.us.vr-common-library",
"type": "fhir.ig",
"title": "Vital Records Common Profiles Library",
"author": "HL7 International - Public Health Work Group",
"id": "hl7.fhir.us.vr-common-library@0.1.0",
"directories": {
"lib": "package",
"example": "example"
},
"canonical": "http://hl7.org/fhir/us/vr-common-library",
"url": "http://hl7.org/fhir/us/vr-common-library/2021Jan",
"version": "0.1.0",
"maintainers": [ {
"url": "http://www.hl7.org/Special/committees/pher",
"name": "HL7 International - Public Health"
} ],
"dependencies": {
"us.cdc.phinvads": "0.7.0",
"hl7.fhir.r4.core": "4.0.1",
"hl7.fhir.us.core": "3.1.0"
}
},
"2.0.0": {
"fhirVersions": [ "4.0.1" ],
"tools-version": 3,
"_id": "hl7.fhir.us.vr-common-library@2.0.0",
"date": "20241011180339",
"license": "CC0-1.0",
"jurisdiction": "urn:iso:std:iso:3166#US",
"dist": {
"tarball": "https://fs.get-ig.org/-/hl7.fhir.us.vr-common-library-2.0.0.tgz"
},
"name": "hl7.fhir.us.vr-common-library",
"type": "IG",
"title": "Vital Records Common Library (VRCL) FHIR Implementation Guide",
"author": "HL7 International / Public Health",
"id": "hl7.fhir.us.vr-common-library@2.0.0",
"directories": {
"lib": "package",
"example": "example"
},
"canonical": "http://hl7.org/fhir/us/vr-common-library",
"url": "http://hl7.org/fhir/us/vr-common-library/STU2",
"version": "2.0.0",
"maintainers": [ {
"url": "http://www.hl7.org/Special/committees/pher",
"name": "HL7 International / Public Health"
} ],
"dependencies": {
"us.nlm.vsac": "0.19.0",
"us.cdc.phinvads": "0.12.0",
"hl7.fhir.r4.core": "4.0.1",
"hl7.fhir.us.core": "5.0.1",
"hl7.terminology.r4": "6.0.2",
"hl7.fhir.uv.extensions.r4": "5.1.0"
}
},
"1.0.0": {
"description": "The purpose of this project is to create an HL7 Fast Healthcare Interoperability Resources (FHIR) Library standard to support the needs of multiple Vital Records Implementation Guides.\n\nThis guide is a FHIR Resources (FHIR) Library to support the needs of multiple Vital Records Implementation Guides. It does not provide any use case or scenario specific content or additional guidance on how to use these artifacts, but serves as a source for a standard set of profiles for reuse in multiple use case specific implementation guides focusing on the exchange of Vital Records information. Implementation details such as how and when to use a given artifact will be supplied in these guides.\n\n### Background\nAfter evaluation and analysis of two separate FHIR IG projects - [Birth Defects Reporting](https://build.fhir.org/ig/HL7/fhir-birthdefectsreporting-ig/) and [Birth and Fetal Death Reporting](http://build.fhir.org/ig/HL7/fhir-bfdr), it was determined that there are many common data elements between the two IGs. The short-term scope of this common profiles library will include data elements common to the above-mentioned FHIR IGs and will define a US Realm specific framework that defines common elements for the implementation guides. The longer-term scope of this profiles library will include analysis and possible inclusion of data elements from other Vital Records projects (such as [Vital Records Mortality and Morbidity Reporting FHIR IG](https://build.fhir.org/ig/HL7/vrdr/)).\n\nTo avoid defining the same profiles multiple times, this IG contains a US Realm focused profile library for use by Vital Records and other FHIR standards development efforts to define the appropriate FHIR profiles, value sets, etc., once and allow them to be referenced by each of the specific implementation guides. This profile library will provide a standard framework for inclusion in multiple use case specific implementation guides focused on the exchange of Vital Records information to support interoperability among public health systems and reduce provider and implementer burden. This FHIR implementation guide uses the US Core profiles. Where this FHIR implementation guide is unable to use a US Core profile, we have followed the Cross Group Projects WG's variance request process, and have provided the US Realm Steering Committee an approved rationale for deviation in the implementation guide.\n\nFor Clinical Safety Information please refer to the [FHIR Implementer’s Safety Checklist](http://hl7.org/fhir/safety.html).\n\n### How to Read This Guide\n\nThis Guide is divided into several pages which are listed at the top of each page in the menu bar.\n\n* Home: The home page provides the introduction and background for HL7 FHIR® Vital Records Common Profiles Library.\n* Terminology: This page provides a listing of the value sets used in this guide.\n* Downloads: This page provides links to downloadable artifacts.\n* Artifact Index: This page provides a list of the FHIR artifacts (profiles, examples, and value sets) defined as part of this guide. (built Tue, Oct 12, 2021 12:37+0000+00:00)",
"fhirVersions": [ "4.0.1" ],
"tools-version": 3,
"_id": "hl7.fhir.us.vr-common-library@1.0.0",
"date": "20211012123706",
"license": "CC0-1.0",
"jurisdiction": "urn:iso:std:iso:3166#US",
"dist": {
"tarball": "https://fs.get-ig.org/-/hl7.fhir.us.vr-common-library-1.0.0.tgz"
},
"name": "hl7.fhir.us.vr-common-library",
"type": "fhir.ig",
"title": "Vital Records Common Profiles Library",
"author": "HL7 International - Public Health Work Group",
"id": "hl7.fhir.us.vr-common-library@1.0.0",
"directories": {
"lib": "package",
"example": "example"
},
"canonical": "http://hl7.org/fhir/us/vr-common-library",
"url": "http://hl7.org/fhir/us/vr-common-library/STU1",
"version": "1.0.0",
"maintainers": [ {
"url": "http://www.hl7.org/Special/committees/pher",
"name": "HL7 International - Public Health"
} ],
"dependencies": {
"us.cdc.phinvads": "0.7.0",
"hl7.fhir.r4.core": "4.0.1",
"hl7.fhir.us.core": "4.0.0"
}
},
"2.0.0-ballot": {
"fhirVersions": [ "4.0.1" ],
"tools-version": 3,
"_id": "hl7.fhir.us.vr-common-library@2.0.0-ballot",
"date": "20231216220623",
"license": "CC0-1.0",
"dist": {
"tarball": "https://fs.get-ig.org/-/hl7.fhir.us.vr-common-library-2.0.0-ballot.tgz"
},
"name": "hl7.fhir.us.vr-common-library",
"type": "IG",
"title": "Vital Records Common Library (VRCL) STU2-ballot",
"author": "HL7 International / Public Health",
"id": "hl7.fhir.us.vr-common-library@2.0.0-ballot",
"directories": {
"lib": "package",
"example": "example"
},
"canonical": "http://hl7.org/fhir/us/vr-common-library",
"url": "http://hl7.org/fhir/us/vr-common-library/2024Jan",
"version": "2.0.0-ballot",
"maintainers": [ {
"url": "http://www.hl7.org/Special/committees/pher",
"name": "HL7 International / Public Health"
} ],
"dependencies": {
"us.nlm.vsac": "0.17.0",
"hl7.fhir.us.odh": "1.3.0",
"us.cdc.phinvads": "0.12.0",
"hl7.fhir.r4.core": "4.0.1",
"hl7.fhir.us.core": "5.0.1",
"hl7.terminology.r4": "5.3.0",
"hl7.fhir.uv.extensions.r4": "1.0.0"
}
}
},
"version": "2.0.0",
"maintainers": [ {
"url": "http://www.hl7.org/Special/committees/pher",
"name": "HL7 International / Public Health"
} ],
"dependencies": {
"us.nlm.vsac": "0.19.0",
"us.cdc.phinvads": "0.12.0",
"hl7.fhir.r4.core": "4.0.1",
"hl7.fhir.us.core": "5.0.1",
"hl7.terminology.r4": "6.0.2",
"hl7.fhir.uv.extensions.r4": "5.1.0"
}
}