Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG
1.0.0 - STU1 United States of America flag

Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG, published by HL7 International / Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/HL7/fhir-registry-protocols-ig/ and changes regularly. See the Directory of published versions

Logical Model: Example_Submission_map - Mappings

Active as of 2021-11-01

Mappings for the ExampleMap logical model.

Mappings for Fast Health Interoperability Resources (http://fhir.hl7.org)

Path to where in a FHIR Resource the data element is found

Example_Submission_map
ExampleMap
   demographics
      lastNamePatient.name.family
      firstNamePatient.name.given[0]
      middleNamePatient.name.given[position()>0]
   episodeInformation
      episodeUniqueKeyiif(Encounter.identifier(type.code='VN').value, Encounter.identifier(type.code='VN').value, Encounter.identifier[0].value)
      admissionDateAndTimeEncounter.period.start
      healthInsuranceClaim.where(encounter=Encounter.id).insurance.coverage.exists()
      healthInsuranceClaimNumberresolve(Claim.where(encounter=Encounter.id).insurance.coverage).identifier.value
      healthInsurancePaymentSourceresolve(Claim.where(encounter=Encounter.id)).insurer.display.value
      medicareBeneficiaryIdentifierPatient.identifier.where(system='http://hl7.org/fhir/sid/us-mbi').value
      patientEnrolledInResearchStudyResearchSubject.where(patient=Patient.id and period.overlaps(Encounter.period)).exists()
      patientRestrictionPatient.meta.securityLabel.memberOf(%Restricted)
   arrivalInformation
      numberOfTransferringFacilityUnavailableresolve(Encounter.hospital.where(admitSource.coding.where(code ='hosp-trans' and system='http://terminology.hl7.org/CodeSystem/admit-source')).origin).identifier.where(system='').exists().not()
      transferringFacilityAmericanHospitalAssociationNameresolve(Encounter.hospital.where(admitSource.coding.where(code ='hosp-trans' and system='http://terminology.hl7.org/CodeSystem/admit-source')).origin).name
      transferringFacilityAmericanHospitalAssociationNumberresolve(Encounter.hospital.where(admitSource.coding.where(code ='hosp-trans' and system='http://terminology.hl7.org/CodeSystem/admit-source')).origin).identifier.where(system='').value
   cardiacStatus
      bystanderCardiopulmonaryResuscitationObservation.where(code='112000000186' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      cardiacArrestAfterArrivalOfEmergencyMedicalServicesObservation.where(code='100014081' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      cardiacArrestAtTransferringHealthcareFacilityObservation.where(code='100014016' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      cardiacArrestOutOfHealthcareFacilityObservation.where(code='10001424808' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      cardiacArrestWitnessedObservation.where(code='100014082' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      firstCardiacArrestRhythmObservation.where(code='100014013' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      firstCardiacArrestRhythmUnknownObservation.where(code='100014013' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
   historyAndRiskFactors
      basicActivitiesOfDailyLivingObservation.where(code='112000000180' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      basicActivitiesOfDailyLivingUnknownObservation.where(code='112000000180' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      cognitionObservation.where(code='112000000140' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      cognitionUnknownObservation.where(code='112000000140' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      smokingAmountObservation.where(code='100001256' and system='https://cvquality.acc.org/NCDR' and effectiveDateTime > %Encounter.period.start).first()
      tobaccoTypeObservation.where(code='266918002' and system='http://snomed.info/sct' and effectiveDateTime > %Encounter.period.start).first()
      tobaccoUseObservation.where(code='110483000' and system='http://snomed.info/sct' and effectiveDateTime > %Encounter.period.start).first()
      walkingObservation.where(code='116329008' and system='http://snomed.info/sct' and effectiveDateTime > %Encounter.period.start).first()
      walkingUnknownObservation.where(code='116329008' and system='http://snomed.info/sct' and effectiveDateTime > %Encounter.period.start).first()
   researchStudy
      researchStudyNameresolve(ResearchSubject.where(patient=Patient.id and period.overlaps(Encounter.period)).researchStudy).title
      researchStudyPatientIdResearchSubject.where( individual = Patient.id and ((( Encounter.period.start >= period.start ) and (Encounter.period.start <= period.end)) or ((Encounter.period.end >= period.start) and (Encounter.period.end <= period.end )))).identifier

Mappings for Clinical Document Architecture (http://build.fhir.org/ig/HL7/cda-core-2.0/)

Path to where in a CDA 2.0/CCDA 2.1 Document the data element is found

Example_Submission_map
ExampleMap
   demographics
      lastNameClinicalDocument.recordTarget.patient.name.family
      firstNameClinicalDocument.recordTarget.patient.name.given[1]
      middleNameClinicalDocument.recordTarget.patient.name.given[position()>1]
   episodeInformation
      episodeUniqueKeyClinicalDocument.componentOf.encompassingEncounter.id

Mappings for HL7 V2 Messages (http://www.hl7.eu/refactored/index.html)

Path to where in a HL7 V2 Message the data element is found

Example_Submission_map
ExampleMap
   demographics
      lastNameADT_A01.PID.5.1
      firstNameADT_A01.PID.5.2
      middleNameADT_A01.PID.5.3
   episodeInformation
      episodeUniqueKeyADT_A01.PV1.19.1

Mappings for Submission Data Output location (http://hl7.org/fhir/us/core)

Location within the requirements profile to place the data for submission in US Core or FHIR Core Resources

Example_Submission_map
ExampleMap
   demographics
      lastNamePatient.name.family

http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient.name.family
      firstNamePatient.name.given

http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient.name.given[0]
      middleNamePatient.name.given

http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient.name.given[position()>1]
   episodeInformation
      episodeUniqueKeyEncounter.identifier

http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter.identifier[0].value)
      admissionDateAndTimeObservation

Observation
      healthInsuranceObservation

Observation
      healthInsuranceClaimNumberObservation

Observation
      healthInsurancePaymentSourceObservation

Observation
      medicareBeneficiaryIdentifierObservation

Observation
      patientEnrolledInResearchStudyObservation

Observation
      patientRestrictionObservation

Observation
   arrivalInformation
      numberOfTransferringFacilityUnavailableObservation

Observation
      transferringFacilityAmericanHospitalAssociationNameObservation

Observation
      transferringFacilityAmericanHospitalAssociationNumberObservation

Observation
   cardiacStatus
      bystanderCardiopulmonaryResuscitationObservation

Observation
      cardiacArrestAfterArrivalOfEmergencyMedicalServicesObservation

Observation
      cardiacArrestAtTransferringHealthcareFacilityObservation

Observation
      cardiacArrestOutOfHealthcareFacilityObservation

Observation
      cardiacArrestWitnessedObservation

Observation
      firstCardiacArrestRhythmObservation

Observation
      firstCardiacArrestRhythmUnknownObservation

Observation
   historyAndRiskFactors
      basicActivitiesOfDailyLivingObservation

Observation
      basicActivitiesOfDailyLivingUnknownObservation

Observation
      cognitionObservation

Observation
      cognitionUnknownObservation

Observation
      smokingAmountObservation

Observation
      tobaccoTypeObservation

Observation
      tobaccoUseObservation

Observation
      walkingObservation

Observation
      walkingUnknownObservation

Observation
   researchStudy
      researchStudyNameObservation

Observation
      researchStudyPatientIdObservation

Observation