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

This page is part of the Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Logical Model: Example Submission Map

Official URL: http://hl7.org/fhir/us/registry-protocols/StructureDefinition/ExampleMap Version: 1.0.0-ballot
Active as of 2021-11-01 Computable Name: Example_Submission_map

This is an example of the data that would be used for a Resgistry Submission. The full map is a logical model as that allows conformance to the FHIR Standard the way a custom Resource would not. Each element has the short name of the data, a full description and the paths to fetch and place the information, by data standard type, for each. A section (such as Demographics) is a BackboneElement (holds no values). All subordinate elements are strings. Each mapping includes the following:

  • identity = standard used for the mapping (e.g., FHIR)
  • language = mime type that matches identity
  • map = FHIRPath expression of the path to the data
  • comment = Output mapping only Resource/Profile for inclusion in the Submission Bundle

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExampleMap 0..*BaseExample Submission Map
... demographics 1..1BackboneElementPatient Demographics
.... lastName 1..1stringLast Name
.... firstName 1..1stringFirst Name
.... middleName 0..*stringMiddle Name
... episodeInformation 1..1BackboneElementCathPCI Episode Information
.... episodeUniqueKey 1..1stringEpisode Unique Key
.... admissionDateAndTime 1..1stringAdmission Date and Time
.... healthInsurance 1..1stringHealth Insurance
.... healthInsuranceClaimNumber 1..1stringHealth Insurance Claim Number (HIC)
.... healthInsurancePaymentSource 1..*stringHealth Insurance Payment Source
.... medicareBeneficiaryIdentifier 1..1stringMedicare Beneficiary Identifier
.... patientEnrolledInResearchStudy 1..1stringPatient Enrolled in Research Study
.... patientRestriction 1..1stringPatient Restriction
... arrivalInformation 1..1BackboneElementPatient Arrival Information
.... numberOfTransferringFacilityUnavailable 1..1stringNumber of Transferring Facility Unavailable
.... transferringFacilityAmericanHospitalAssociationName 1..1stringTransferring Facility American Hospital Association Name
.... transferringFacilityAmericanHospitalAssociationNumber 1..1stringTransferring Facility American Hospital Association Number
.... bystanderCardiopulmonaryResuscitation 1..1stringBystander Cardiopulmonary Resuscitation
.... cardiacArrestAfterArrivalOfEmergencyMedicalServices 1..1stringCardiac Arrest After Arrival of Emergency Medical Services
.... cardiacArrestAtTransferringHealthcareFacility 1..1stringCardiac Arrest at Transferring Healthcare Facility
.... cardiacArrestOutOfHealthcareFacility 1..1stringCardiac Arrest Out of Healthcare Facility
.... cardiacArrestWitnessed 1..1stringCardiac Arrest Witnessed
.... firstCardiacArrestRhythm 1..1stringFirst Cardiac Arrest Rhythm
.... firstCardiacArrestRhythmUnknown 1..1stringFirst Cardiac Arrest Rhythm Unknown
... historyAndRiskFactors 1..1BackboneElementPatient History and Risk Factors
.... basicActivitiesOfDailyLiving 1..1stringBasic Activities of Daily Living
.... basicActivitiesOfDailyLivingUnknown 1..1stringBasic Activities of Daily Living Unknown
.... cognition 1..1stringCognition
.... cognitionUnknown 1..1stringCognition Unknown
.... smokingAmount 1..1stringSmoking Amount
.... tobaccoType 1..1stringTobacco Type
.... tobaccoUse 1..1stringTobacco Use
.... walking 1..1stringWalking
.... walkingUnknown 1..1stringWalking Unknown
... researchStudy 0..1BackboneElementResearch Study Information
.... researchStudyName 1..1stringResearch Study Name
.... researchStudyPatientId 1..1stringResearch Study Patient ID

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ExampleMap 0..*BaseExample Submission Map
... demographics 1..1BackboneElementPatient Demographics
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lastName 1..1stringLast Name
.... firstName 1..1stringFirst Name
.... middleName 0..*stringMiddle Name
... episodeInformation 1..1BackboneElementCathPCI Episode Information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... episodeUniqueKey 1..1stringEpisode Unique Key
.... admissionDateAndTime 1..1stringAdmission Date and Time
.... healthInsurance 1..1stringHealth Insurance
.... healthInsuranceClaimNumber 1..1stringHealth Insurance Claim Number (HIC)
.... healthInsurancePaymentSource 1..*stringHealth Insurance Payment Source
.... medicareBeneficiaryIdentifier 1..1stringMedicare Beneficiary Identifier
.... patientEnrolledInResearchStudy 1..1stringPatient Enrolled in Research Study
.... patientRestriction 1..1stringPatient Restriction
... arrivalInformation 1..1BackboneElementPatient Arrival Information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... numberOfTransferringFacilityUnavailable 1..1stringNumber of Transferring Facility Unavailable
.... transferringFacilityAmericanHospitalAssociationName 1..1stringTransferring Facility American Hospital Association Name
.... transferringFacilityAmericanHospitalAssociationNumber 1..1stringTransferring Facility American Hospital Association Number
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... bystanderCardiopulmonaryResuscitation 1..1stringBystander Cardiopulmonary Resuscitation
.... cardiacArrestAfterArrivalOfEmergencyMedicalServices 1..1stringCardiac Arrest After Arrival of Emergency Medical Services
.... cardiacArrestAtTransferringHealthcareFacility 1..1stringCardiac Arrest at Transferring Healthcare Facility
.... cardiacArrestOutOfHealthcareFacility 1..1stringCardiac Arrest Out of Healthcare Facility
.... cardiacArrestWitnessed 1..1stringCardiac Arrest Witnessed
.... firstCardiacArrestRhythm 1..1stringFirst Cardiac Arrest Rhythm
.... firstCardiacArrestRhythmUnknown 1..1stringFirst Cardiac Arrest Rhythm Unknown
... historyAndRiskFactors 1..1BackboneElementPatient History and Risk Factors
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... basicActivitiesOfDailyLiving 1..1stringBasic Activities of Daily Living
.... basicActivitiesOfDailyLivingUnknown 1..1stringBasic Activities of Daily Living Unknown
.... cognition 1..1stringCognition
.... cognitionUnknown 1..1stringCognition Unknown
.... smokingAmount 1..1stringSmoking Amount
.... tobaccoType 1..1stringTobacco Type
.... tobaccoUse 1..1stringTobacco Use
.... walking 1..1stringWalking
.... walkingUnknown 1..1stringWalking Unknown
... researchStudy 0..1BackboneElementResearch Study Information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... researchStudyName 1..1stringResearch Study Name
.... researchStudyPatientId 1..1stringResearch Study Patient ID

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ExampleMap 0..*BaseExample Submission Map
... demographics 1..1BackboneElementPatient Demographics
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lastName 1..1stringLast Name
.... firstName 1..1stringFirst Name
.... middleName 0..*stringMiddle Name
... episodeInformation 1..1BackboneElementCathPCI Episode Information
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... episodeUniqueKey 1..1stringEpisode Unique Key
.... admissionDateAndTime 1..1stringAdmission Date and Time
.... healthInsurance 1..1stringHealth Insurance
.... healthInsuranceClaimNumber 1..1stringHealth Insurance Claim Number (HIC)
.... healthInsurancePaymentSource 1..*stringHealth Insurance Payment Source
.... medicareBeneficiaryIdentifier 1..1stringMedicare Beneficiary Identifier
.... patientEnrolledInResearchStudy 1..1stringPatient Enrolled in Research Study
.... patientRestriction 1..1stringPatient Restriction
... arrivalInformation 1..1BackboneElementPatient Arrival Information
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... numberOfTransferringFacilityUnavailable 1..1stringNumber of Transferring Facility Unavailable
.... transferringFacilityAmericanHospitalAssociationName 1..1stringTransferring Facility American Hospital Association Name
.... transferringFacilityAmericanHospitalAssociationNumber 1..1stringTransferring Facility American Hospital Association Number
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... bystanderCardiopulmonaryResuscitation 1..1stringBystander Cardiopulmonary Resuscitation
.... cardiacArrestAfterArrivalOfEmergencyMedicalServices 1..1stringCardiac Arrest After Arrival of Emergency Medical Services
.... cardiacArrestAtTransferringHealthcareFacility 1..1stringCardiac Arrest at Transferring Healthcare Facility
.... cardiacArrestOutOfHealthcareFacility 1..1stringCardiac Arrest Out of Healthcare Facility
.... cardiacArrestWitnessed 1..1stringCardiac Arrest Witnessed
.... firstCardiacArrestRhythm 1..1stringFirst Cardiac Arrest Rhythm
.... firstCardiacArrestRhythmUnknown 1..1stringFirst Cardiac Arrest Rhythm Unknown
... historyAndRiskFactors 1..1BackboneElementPatient History and Risk Factors
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... basicActivitiesOfDailyLiving 1..1stringBasic Activities of Daily Living
.... basicActivitiesOfDailyLivingUnknown 1..1stringBasic Activities of Daily Living Unknown
.... cognition 1..1stringCognition
.... cognitionUnknown 1..1stringCognition Unknown
.... smokingAmount 1..1stringSmoking Amount
.... tobaccoType 1..1stringTobacco Type
.... tobaccoUse 1..1stringTobacco Use
.... walking 1..1stringWalking
.... walkingUnknown 1..1stringWalking Unknown
... researchStudy 0..1BackboneElementResearch Study Information
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... researchStudyName 1..1stringResearch Study Name
.... researchStudyPatientId 1..1stringResearch Study Patient ID

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element (36 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExampleMap 0..*BaseExample Submission Map
... demographics 1..1BackboneElementPatient Demographics
.... lastName 1..1stringLast Name
.... firstName 1..1stringFirst Name
.... middleName 0..*stringMiddle Name
... episodeInformation 1..1BackboneElementCathPCI Episode Information
.... episodeUniqueKey 1..1stringEpisode Unique Key
.... admissionDateAndTime 1..1stringAdmission Date and Time
.... healthInsurance 1..1stringHealth Insurance
.... healthInsuranceClaimNumber 1..1stringHealth Insurance Claim Number (HIC)
.... healthInsurancePaymentSource 1..*stringHealth Insurance Payment Source
.... medicareBeneficiaryIdentifier 1..1stringMedicare Beneficiary Identifier
.... patientEnrolledInResearchStudy 1..1stringPatient Enrolled in Research Study
.... patientRestriction 1..1stringPatient Restriction
... arrivalInformation 1..1BackboneElementPatient Arrival Information
.... numberOfTransferringFacilityUnavailable 1..1stringNumber of Transferring Facility Unavailable
.... transferringFacilityAmericanHospitalAssociationName 1..1stringTransferring Facility American Hospital Association Name
.... transferringFacilityAmericanHospitalAssociationNumber 1..1stringTransferring Facility American Hospital Association Number
.... bystanderCardiopulmonaryResuscitation 1..1stringBystander Cardiopulmonary Resuscitation
.... cardiacArrestAfterArrivalOfEmergencyMedicalServices 1..1stringCardiac Arrest After Arrival of Emergency Medical Services
.... cardiacArrestAtTransferringHealthcareFacility 1..1stringCardiac Arrest at Transferring Healthcare Facility
.... cardiacArrestOutOfHealthcareFacility 1..1stringCardiac Arrest Out of Healthcare Facility
.... cardiacArrestWitnessed 1..1stringCardiac Arrest Witnessed
.... firstCardiacArrestRhythm 1..1stringFirst Cardiac Arrest Rhythm
.... firstCardiacArrestRhythmUnknown 1..1stringFirst Cardiac Arrest Rhythm Unknown
... historyAndRiskFactors 1..1BackboneElementPatient History and Risk Factors
.... basicActivitiesOfDailyLiving 1..1stringBasic Activities of Daily Living
.... basicActivitiesOfDailyLivingUnknown 1..1stringBasic Activities of Daily Living Unknown
.... cognition 1..1stringCognition
.... cognitionUnknown 1..1stringCognition Unknown
.... smokingAmount 1..1stringSmoking Amount
.... tobaccoType 1..1stringTobacco Type
.... tobaccoUse 1..1stringTobacco Use
.... walking 1..1stringWalking
.... walkingUnknown 1..1stringWalking Unknown
... researchStudy 0..1BackboneElementResearch Study Information
.... researchStudyName 1..1stringResearch Study Name
.... researchStudyPatientId 1..1stringResearch Study Patient ID

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExampleMap 0..*BaseExample Submission Map
... demographics 1..1BackboneElementPatient Demographics
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lastName 1..1stringLast Name
.... firstName 1..1stringFirst Name
.... middleName 0..*stringMiddle Name
... episodeInformation 1..1BackboneElementCathPCI Episode Information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... episodeUniqueKey 1..1stringEpisode Unique Key
.... admissionDateAndTime 1..1stringAdmission Date and Time
.... healthInsurance 1..1stringHealth Insurance
.... healthInsuranceClaimNumber 1..1stringHealth Insurance Claim Number (HIC)
.... healthInsurancePaymentSource 1..*stringHealth Insurance Payment Source
.... medicareBeneficiaryIdentifier 1..1stringMedicare Beneficiary Identifier
.... patientEnrolledInResearchStudy 1..1stringPatient Enrolled in Research Study
.... patientRestriction 1..1stringPatient Restriction
... arrivalInformation 1..1BackboneElementPatient Arrival Information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... numberOfTransferringFacilityUnavailable 1..1stringNumber of Transferring Facility Unavailable
.... transferringFacilityAmericanHospitalAssociationName 1..1stringTransferring Facility American Hospital Association Name
.... transferringFacilityAmericanHospitalAssociationNumber 1..1stringTransferring Facility American Hospital Association Number
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... bystanderCardiopulmonaryResuscitation 1..1stringBystander Cardiopulmonary Resuscitation
.... cardiacArrestAfterArrivalOfEmergencyMedicalServices 1..1stringCardiac Arrest After Arrival of Emergency Medical Services
.... cardiacArrestAtTransferringHealthcareFacility 1..1stringCardiac Arrest at Transferring Healthcare Facility
.... cardiacArrestOutOfHealthcareFacility 1..1stringCardiac Arrest Out of Healthcare Facility
.... cardiacArrestWitnessed 1..1stringCardiac Arrest Witnessed
.... firstCardiacArrestRhythm 1..1stringFirst Cardiac Arrest Rhythm
.... firstCardiacArrestRhythmUnknown 1..1stringFirst Cardiac Arrest Rhythm Unknown
... historyAndRiskFactors 1..1BackboneElementPatient History and Risk Factors
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... basicActivitiesOfDailyLiving 1..1stringBasic Activities of Daily Living
.... basicActivitiesOfDailyLivingUnknown 1..1stringBasic Activities of Daily Living Unknown
.... cognition 1..1stringCognition
.... cognitionUnknown 1..1stringCognition Unknown
.... smokingAmount 1..1stringSmoking Amount
.... tobaccoType 1..1stringTobacco Type
.... tobaccoUse 1..1stringTobacco Use
.... walking 1..1stringWalking
.... walkingUnknown 1..1stringWalking Unknown
... researchStudy 0..1BackboneElementResearch Study Information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... researchStudyName 1..1stringResearch Study Name
.... researchStudyPatientId 1..1stringResearch Study Patient ID

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExampleMap 0..*BaseExample Submission Map
... demographics 1..1BackboneElementPatient Demographics
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lastName 1..1stringLast Name
.... firstName 1..1stringFirst Name
.... middleName 0..*stringMiddle Name
... episodeInformation 1..1BackboneElementCathPCI Episode Information
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... episodeUniqueKey 1..1stringEpisode Unique Key
.... admissionDateAndTime 1..1stringAdmission Date and Time
.... healthInsurance 1..1stringHealth Insurance
.... healthInsuranceClaimNumber 1..1stringHealth Insurance Claim Number (HIC)
.... healthInsurancePaymentSource 1..*stringHealth Insurance Payment Source
.... medicareBeneficiaryIdentifier 1..1stringMedicare Beneficiary Identifier
.... patientEnrolledInResearchStudy 1..1stringPatient Enrolled in Research Study
.... patientRestriction 1..1stringPatient Restriction
... arrivalInformation 1..1BackboneElementPatient Arrival Information
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... numberOfTransferringFacilityUnavailable 1..1stringNumber of Transferring Facility Unavailable
.... transferringFacilityAmericanHospitalAssociationName 1..1stringTransferring Facility American Hospital Association Name
.... transferringFacilityAmericanHospitalAssociationNumber 1..1stringTransferring Facility American Hospital Association Number
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... bystanderCardiopulmonaryResuscitation 1..1stringBystander Cardiopulmonary Resuscitation
.... cardiacArrestAfterArrivalOfEmergencyMedicalServices 1..1stringCardiac Arrest After Arrival of Emergency Medical Services
.... cardiacArrestAtTransferringHealthcareFacility 1..1stringCardiac Arrest at Transferring Healthcare Facility
.... cardiacArrestOutOfHealthcareFacility 1..1stringCardiac Arrest Out of Healthcare Facility
.... cardiacArrestWitnessed 1..1stringCardiac Arrest Witnessed
.... firstCardiacArrestRhythm 1..1stringFirst Cardiac Arrest Rhythm
.... firstCardiacArrestRhythmUnknown 1..1stringFirst Cardiac Arrest Rhythm Unknown
... historyAndRiskFactors 1..1BackboneElementPatient History and Risk Factors
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... basicActivitiesOfDailyLiving 1..1stringBasic Activities of Daily Living
.... basicActivitiesOfDailyLivingUnknown 1..1stringBasic Activities of Daily Living Unknown
.... cognition 1..1stringCognition
.... cognitionUnknown 1..1stringCognition Unknown
.... smokingAmount 1..1stringSmoking Amount
.... tobaccoType 1..1stringTobacco Type
.... tobaccoUse 1..1stringTobacco Use
.... walking 1..1stringWalking
.... walkingUnknown 1..1stringWalking Unknown
... researchStudy 0..1BackboneElementResearch Study Information
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... researchStudyName 1..1stringResearch Study Name
.... researchStudyPatientId 1..1stringResearch Study Patient ID

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element (36 nested mandatory elements)

 

Other representations of profile: CSV, Excel