This page is part of the Vital Records Common Profile Library (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Downloads

Download

You can also download:

• this entire guide
• the definition resources in json, xml, ttl, or csv format, or
• the example resources in json, xml or ttl format.

The source code for this Implementation Guide can be found on IHE GitHub https://github.com/HL7/vr-common-library.

Cross Version Analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.us.vr-common-library.r4) and R4B (hl7.fhir.us.vr-common-library.r4b) are available.

Dependency Table

Package hl7.fhir.uv.extensions.r4#5.1.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00)

Package hl7.fhir.uv.bulkdata#2.0.0 FHIR based approach for exporting large data sets from a FHIR server to a client application (built Fri, Nov 26, 2021 05:56+1100+11:00)

Package hl7.fhir.uv.sdc#3.0.0 The SDC specification provides an infrastructure to standardize the capture and expanded use of patient-level data collected within an EHR. This includes two components: * Support more sophisticated questionnaire/form use-cases such as those needed for research, oncology, pathology and other clinical domains. *Support pre-population and auto-population of EHR data into forms/questionnaires for uses outside direct clinical care (patient safety, adverse event reporting, public health reporting, etc.). (built Tue, Mar 8, 2022 18:32+0000+00:00)

Package hl7.fhir.us.core#5.0.1 The US Core Implementation Guide is based on FHIR Version R4 and defines the minimum conformance requirements for accessing patient data. The Argonaut pilot implementations, ONC 2015 Edition Common Clinical Data Set (CCDS), and ONC U.S. Core Data for Interoperability (USCDI) v1 provided the requirements for this guide. The prior Argonaut search and vocabulary requirements, based on FHIR DSTU2, are updated in this guide to support FHIR Version R4. This guide was used as the basis for further testing and guidance by the Argonaut Project Team to provide additional content and guidance specific to Data Query Access for purpose of ONC Certification testing. These profiles are the foundation for future US Realm FHIR implementation guides. In addition to Argonaut, they are used by DAF-Research, QI-Core, and CIMI. Under the guidance of HL7 and the HL7 US Realm Steering Committee, the content will expand in future versions to meet the needs specific to the US Realm. These requirements were originally developed, balloted, and published in FHIR DSTU2 as part of the Office of the National Coordinator for Health Information Technology (ONC) sponsored Data Access Framework (DAF) project. For more information on how DAF became US Core see the US Core change notes. (built Wed, Jun 22, 2022 19:44+0000+00:00)

Globals Table

There are no Global profiles defined

IP Statements

This publication includes IP covered under the following statements.

• Copyright HL7. Licensed under creative commons public domain
  Show Usage
  • degreeLicenseCertificate: ObservationEducationLevelVitalRecords and ValueSetEducationLevelVitalRecords
• ISO maintains the copyright on the country codes, and controls its use carefully. For further details see the ISO 3166 web page: https://www.iso.org/iso-3166-country-codes.html
  Show Usage
  • ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code: AuxiliaryStateIdentifier1VitalRecords, AuxiliaryStateIdentifier2VitalRecords... Show 87 more, BirthAttendantTitles, BirthSex, CertificateNumberVitalRecords, CodeSystemComponentVitalRecords, CodeSystemCountryCodeVitalRecords, CodeSystemEditFlagsVitalRecords, CodeSystemHispanicOriginVitalRecords, CodeSystemIJEVitalRecords, CodeSystemJurisdictionsVitalRecords, CodeSystemLocalObservationsCodesVitalRecords, CodeSystemRaceCodeVitalRecords, CodeSystemRaceRecode40VitalRecords, CodeSystemUSStatesTerritoriesVitalRecords, DateOfBirthEditFlags, EditBypass01234, EducationLevel, ExtensionBypassEditFlagVitalRecords, ExtensionCityCodeVitalRecords, ExtensionDistrictCodeVitalRecords, ExtensionLocationJurisdictionIdVitalRecords, ExtensionPartialDateTimeVitalRecords, ExtensionPartialDateVitalRecords, ExtensionPatientFetalDeathVitalRecords, ExtensionPostDirectionalVitalRecords, ExtensionPreDirectionalVitalRecords, ExtensionRelatedpersonBirthplaceVitalRecords, ExtensionReportedParentAgeAtDeliveryVitalRecords, ExtensionStreetDesignatorVitalRecords, ExtensionStreetNameVitalRecords, ExtensionStreetNumberVitalRecords, ExtensionUnitOrAptNumberVitalRecords, ExtensionWithinCityLimitsIndicatorVitalRecords, HispanicNoUnknown, HispanicOrigin, LocationVitalRecords, MaritalStatus, NotApplicable, ObservationCodedRaceAndEthnicityVitalRecords, ObservationEducationLevelVitalRecords, ObservationEmergingIssuesVitalRecords, ObservationInputRaceAndEthnicityVitalRecords, PatientChildVitalRecords, PatientMotherVitalRecords, PatientVitalRecords, PluralityEditFlags, PractitionerVitalRecords, RaceCodes, RaceMissingValueReason, RaceRecode40, RelatedPersonFatherNaturalVitalRecords, RelatedPersonFatherVitalRecords, RelatedPersonMotherVitalRecords, RelatedPersonParentVitalRecords, UnitsOfAge, ValueSetBirthAttendantTitlesVitalRecords, ValueSetBirthplaceCountryVitalRecords, ValueSetCodedRaceAndEthnicityPersonVitalRecords, ValueSetDateOfBirthEditFlagsVitalRecords, ValueSetEditBypass01234VitalRecords, ValueSetEducationLevelPersonVitalRecords, ValueSetEducationLevelVitalRecords, ValueSetFatherRelationshipVitalRecords, ValueSetHispanicOriginVitalRecords, ValueSetIJEVitalRecords, ValueSetInputRaceAndEthnicityPersonVitalRecords, ValueSetJurisdictionVitalRecords, ValueSetMaritalStatusVitalRecords, ValueSetMotherRelationshipVitalRecords, ValueSetPartialDateDataAbsentReasonVitalRecords, ValueSetPluralityEditFlagsVitalRecords, ValueSetRaceCodeVitalRecords, ValueSetRaceMissingValueReasonVitalRecords, ValueSetRaceRecode40VitalRecords, ValueSetResidenceCountryVitalRecords, ValueSetRoleVitalRecords, ValueSetSexAssignedAtBirthVitalRecords, ValueSetStatesTerritoriesAndProvincesVitalRecords, ValueSetUSStatesAndTerritoriesVitalRecords, ValueSetUSStatesVitalRecords, ValueSetUSTerritoriesVitalRecords, ValueSetUnitsOfAgeVitalRecords, ValueSetYesNoNotApplicableVitalRecords, ValueSetYesNoUnknownNotApplicableVitalRecords, ValueSetYesNoUnknownVitalRecords, VitalRecordsCommonLibrary, YesNoUnknown and YesNoUnknownNotApplicable
• The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
  Show Usage
  • Unified Code for Units of Measure (UCUM): Patient/patient-child-vr-babyg-quinn-common, Patient/patient-child-vr-babyg-quinn-common-1, Patient/patient-child-vr-babyg-quinn-common-2, Patient/patient-child-vr-babyg-quinn-w-edit and ValueSetUnitsOfAgeVitalRecords
• This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
  Show Usage
  • LOINC: Observation/observation-education-level-vr-a-freeman, Observation/observation-partial-date-time-example, ObservationEducationLevelVitalRecords and ValueSetEducationLevelPersonVitalRecords
• This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  • SNOMED Clinical Terms® (SNOMED CT®): Practitioner/practitioner-vr-janet-seito-common and ValueSetBirthAttendantTitlesVitalRecords
• This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  • DataAbsentReason: ExtensionPartialDateTimeVitalRecords, ExtensionPartialDateVitalRecords and ValueSetPartialDateDataAbsentReasonVitalRecords
  • UsageContextType: BirthAttendantTitles, BirthSex... Show 14 more, DateOfBirthEditFlags, EditBypass01234, EducationLevel, HispanicNoUnknown, HispanicOrigin, MaritalStatus, NotApplicable, PluralityEditFlags, RaceCodes, RaceMissingValueReason, RaceRecode40, UnitsOfAge, YesNoUnknown and YesNoUnknownNotApplicable
  • identifierType: Patient/patient-child-vr-babyg-quinn-common, Patient/patient-child-vr-babyg-quinn-common-1... Show 15 more, Patient/patient-child-vr-babyg-quinn-common-2, Patient/patient-child-vr-babyg-quinn-w-edit, Patient/patient-fetal-death-example, Patient/patient-mother-vr-birth-date-part-absent, Patient/patient-mother-vr-jada-ann-quinn-common, Patient/us-core-patient-vr-a-freeman, Patient/us-core-patient-vr-unknown-name, PatientChildVitalRecords, PatientMotherVitalRecords, PatientVitalRecords, RelatedPerson/relatedperson-father-natural-vr-james-brandon-quinn-common, RelatedPersonFatherNaturalVitalRecords, RelatedPersonFatherVitalRecords, RelatedPersonMotherVitalRecords and RelatedPersonParentVitalRecords
  • ActReason: ObservationInputRaceAndEthnicityVitalRecords and ValueSetRaceMissingValueReasonVitalRecords
  • AdministrativeGender: PatientChildVitalRecords and ValueSetSexAssignedAtBirthVitalRecords
  • Education Level: Observation/observation-education-level-vr-a-freeman, ObservationEducationLevelVitalRecords and ValueSetEducationLevelVitalRecords
  • MaritalStatus: ValueSetMaritalStatusVitalRecords
  • NullFlavor: ExtensionWithinCityLimitsIndicatorVitalRecords, LocationVitalRecords... Show 15 more, ObservationEducationLevelVitalRecords, ObservationInputRaceAndEthnicityVitalRecords, PatientChildVitalRecords, PatientVitalRecords, PractitionerVitalRecords, ValueSetBirthAttendantTitlesVitalRecords, ValueSetEducationLevelVitalRecords, ValueSetMaritalStatusVitalRecords, ValueSetRaceMissingValueReasonVitalRecords, ValueSetSexAssignedAtBirthVitalRecords, ValueSetStatesTerritoriesAndProvincesVitalRecords, ValueSetUnitsOfAgeVitalRecords, ValueSetYesNoNotApplicableVitalRecords, ValueSetYesNoUnknownNotApplicableVitalRecords and ValueSetYesNoUnknownVitalRecords
  • RoleCode: ExtensionReportedParentAgeAtDeliveryVitalRecords, Patient/patient-child-vr-babyg-quinn-common... Show 14 more, Patient/patient-child-vr-babyg-quinn-common-1, Patient/patient-child-vr-babyg-quinn-common-2, Patient/patient-child-vr-babyg-quinn-w-edit, RelatedPerson/relatedperson-father-natural-vr-james-brandon-quinn-common, RelatedPerson/relatedperson-father-vr-tom-yan-lee-common, RelatedPerson/relatedperson-father-vr-tony-lewis-common, RelatedPerson/relatedperson-mother-vr-carol-hoffer-common, RelatedPerson/relatedperson-parent-vr-stepmother, RelatedPersonFatherNaturalVitalRecords, RelatedPersonFatherVitalRecords, RelatedPersonMotherVitalRecords, ValueSetFatherRelationshipVitalRecords, ValueSetMotherRelationshipVitalRecords and ValueSetRoleVitalRecords