# ╭────────────────────────────────────────────────────────────────────────────────────────────────╮ # │ ACTION REQUIRED: REVIEW AND EDIT THIS FILE TO ENSURE IT ACCURATELY REFLECTS YOUR PROJECT! │ # │ │ # │ This file was generated from your existing project files and will be used for SUSHI │ # │ configuration from now on. You may delete your package.json as it is no longer needed. │ # ╰────────────────────────────────────────────────────────────────────────────────────────────────╯ # ╭─────────────────────────ImplementationGuide-hl7.fhir.us.carin-bb.json──────────────────────────╮ # │ The properties below are used to create the ImplementationGuide resource. For a list of │ # │ supported properties, see: │ # │ http://build.fhir.org/ig/HL7/fhir-shorthand/branches/beta/sushi.html#ig-development │ # ╰────────────────────────────────────────────────────────────────────────────────────────────────╯ id: hl7.fhir.us.carin-bb canonical: http://hl7.org/fhir/us/carin-bb version: 2.1.0 name: CARINConsumerDirectedPayerDataExchange title: CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®) status: active extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg #<<< must include a http://hl7.org/fhir/StructureDefinition/structuredefinition-wg extension that identifies the workgroup responsible for the IG. This is the authoritative element. valueCode: fm # <<< The value must be the code for the workgroup - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use publisher: name: HL7 International / Financial Management url: http://www.hl7.org/Special/committees/fm email: fm@lists.HL7.org description: CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®) license: CC0-1.0 fhirVersion: 4.0.1 dependencies: hl7.fhir.us.core: id: uscore6 version: 6.1.0 reason: | Defines USCDIv3 expectations on a range of resources that will be queried by CARIN BlueButton client systems hl7.fhir.us.core.3.1.1: version: 3.1.1 uri: http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core id: uscore3 reason: | Defines USCDIv3 expectations on a range of resources that will be queried by CARIN BlueButton client systems hl7.fhir.extensions.r5: 4.0.1 us.nlm.vsac: uri: http://fhir.org/packages/us.nlm.vsac/ImplementationGuide/us.nlm.vsac version: 0.21.0 parameters: show-inherited-invariants: false default-jurisdiction: true default-publisher: true default-version: true default-contact: true apply-jurisdiction: false apply-publisher: false apply-version: false apply-contact: false excludettl: 'true' excludemap: 'true' special-url: - https://x12.org/codesystem.x12.org/ambulance-transport-reason-codes - https://www.nubc.org/CodeSystem/PresentOnAdmissionIndicator copyrightYear: 2024+ releaseLabel: STU 2.1 jurisdiction: urn:iso:std:iso:3166#US # ╭────────────────────────────────────────────menu.xml────────────────────────────────────────────╮ # │ To control the menu.xml using this config, uncomment and set the "menu" property. │ # ╰────────────────────────────────────────────────────────────────────────────────────────────────╯ menu: Home: index.html Background: The CARIN Alliance: Background.html#the-carin-alliance Patient Protection: Background.html#patient-protection Relation to Other IGs: Background.html#relation-to-other-IGs Use Cases: Terms and Concepts: Use_Case.html#terms-and-concepts Use Cases: Use_Case.html#use-cases Guidance: Conformance Requirements: Conformance_Requirements.html Common Payer Consumer Data Set (CPCDS): Common_Payer_Consumer_Data_Set.html General Guidance: General_Guidance.html Terminology Licensure: Terminology_Licensure.html FHIR Artifacts: Profiles: artifacts.html#3 Search Parameters: searchparameters.html Terminology: artifacts.html#5 Capability Statement: CapabilityStatement-c4bb.html Security: General Considerations: Security_And_Privacy_Considerations.html#general-considerations Security Requirements: Security_And_Privacy_Considerations.html#security-requirements Examples: artifacts.html#7 Support: Project Home: https://confluence.hl7.org/pages/viewpage.action?pageId=81008633 Discussion Forum: https://chat.fhir.org/#narrow/stream/204607-CARIN-IG-for-Blue-Button.C2.AE Propose a Change: https://jira.hl7.org/secure/CreateIssueDetails!init.jspa?pid=10405&customfield_11302=FHIR-us-carin-bb&issuetype=10600 Downloads: downloads.html Change Notes: change_notes.html pages: index.md: title: Home Background.md: title: Background Use_Case.md: title: Use Case Conformance_Requirements.md: title: Conformance Requirements General_Guidance.md: title: General Guidance Common_Payer_Consumer_Data_Set.md: title: Common Payer Consumer Data Set (CPCDS) Terminology_Licensure.md: title: Terminology Licensure artifacts.html: title: Artifacts Summary searchparameters.md: title: Search Parameters Security_And_Privacy_Considerations.md: title: Security and Privacy Considerations downloads.md: title: Downloads change_notes.md: title: Change Notes # ╭───────────────────────────────────────package-list.json────────────────────────────────────────╮ # │ To control the package-list.json using this config, uncomment and set the "history" property. │ # ╰───────────────────────────────────────────_────────────────────────────────────────────────────╯ groups: capability: name: "Behavior: Capability Statements" description: "The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements." resources: - CapabilityStatement/c4bb search: name: "Behavior: Search Parameters" description: "These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources." resources: - SearchParameter/coverage-payor - SearchParameter/explanationofbenefit-billable-period-start - SearchParameter/explanationofbenefit-care-team - SearchParameter/explanationofbenefit-coverage - SearchParameter/explanationofbenefit-identifier - SearchParameter/explanationofbenefit-insurer - SearchParameter/practitionerrole-organization - SearchParameter/explanationofbenefit-patient - SearchParameter/practitionerrole-practitioner - SearchParameter/explanationofbenefit-provider - SearchParameter/explanationofbenefit-service-date - SearchParameter/explanationofbenefit-service-start-date - SearchParameter/explanationofbenefit-type abstract: name: "Structures: Abstract Profiles" description: "These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles, but do not declare conformance to the abstract profiles themselves." resources: - StructureDefinition/C4BB-ExplanationOfBenefit basis: name: "Structures: Explanation of Benefits Basis Profiles" description: "Basis profiles that define all non-financial element requirements for ExplanationOfBenefit types. These profiles are not expected to be implemented directly within the context of the consumer directed data exchange use case defined by this guide, but rather from within the context in which external guides may define (e.g. Provider Access API of PDEX)." resources: - StructureDefinition/C4BB-ExplanationOfBenefit-Inpatient-Institutional-Basis - StructureDefinition/C4BB-ExplanationOfBenefit-Oral-Basis - StructureDefinition/C4BB-ExplanationOfBenefit-Outpatient-Institutional-Basis - StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy-Basis - StructureDefinition/C4BB-ExplanationOfBenefit-Professional-NonClinician-Basis profiles: name: "Structures: Resource Profiles" description: "These define constraints on FHIR resources for systems conforming to this implementation guide." resources: - StructureDefinition/C4BB-Patient - StructureDefinition/C4BB-Coverage - StructureDefinition/C4BB-Practitioner - StructureDefinition/C4BB-Organization - StructureDefinition/C4BB-RelatedPerson - StructureDefinition/C4BB-ExplanationOfBenefit-Inpatient-Institutional - StructureDefinition/C4BB-ExplanationOfBenefit-Outpatient-Institutional - StructureDefinition/C4BB-ExplanationOfBenefit-Professional-NonClinician - StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy - StructureDefinition/C4BB-ExplanationOfBenefit-Oral resources: Patient/Patient1: name: Patient Example 1 description: Patient Example 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient Patient/Patient2: name: Patient Example 2 description: Patient Example 2 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient Coverage/Coverage1: name: Coverage Example 1 description: Coverage Example1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage Coverage/Coverage2: name: Coverage Example 2 description: Coverage Example 2 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage Coverage/Coverage3: name: Coverage Example 3 description: Coverage Example 3 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage Coverage/CoverageDental1: name: Dental Coverage Example1 description: Dental Coverage Example1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage ExplanationOfBenefit/EOBInpatient1: name: EOB Inpatient Example1 description: EOB Inpatient Example 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Inpatient-Institutional ExplanationOfBenefit/EOBInpatient2: name: EOB Inpatient Example 2 description: EOB Inpatient Example 2 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Inpatient-Institutional ExplanationOfBenefit/EOBOutpatient1: name: EOB Outpatient Institutional - Example 1 description: EOB Outpatient Institutional - Example 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Outpatient-Institutional ExplanationOfBenefit/EOBOutpatient2: name: EOB Outpatient Institutional - Example 2 description: EOB Outpatient Institutional - Example 2 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Outpatient-Institutional ExplanationOfBenefit/EOBProfessional1: name: EOB Professional - Example 1 description: EOB Professional - Example 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Professional-NonClinician ExplanationOfBenefit/EOBProfessional2: name: EOB Professional - Example 2 description: EOB Professional - Example 2 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Professional-NonClinician ExplanationOfBenefit/EOBProfessionalTransportation1: name: EOB Professional - Transportation 1 description: EOB Professional - Transportation 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Professional-NonClinician ExplanationOfBenefit/EOBPharmacy1: name: EOB Pharmacy Example1 description: EOB Pharmacy Example1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Pharmacy ExplanationOfBenefit/EOBOral1: name: EOB Oral Example 1 description: EOB Oral Example 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Oral ExplanationOfBenefit/EOBOral2: name: EOB Oral Example 2 description: EOB Oral Example 2 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit-Oral Organization/ProviderOrganization1: name: Provider Organization 1 description: Provider Organization 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Organization/ProviderOrganization2: name: Provider Organization 2 description: Provider Organization 2 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Organization/ProviderOrganization3: name: Provider Organization 3 description: Provider Organization 3 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Organization/ProviderOrganization4: name: Provider Organization 4 description: Provider Organization 4 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Organization/ProviderOrganization5: name: Provider Organization 5 description: Provider Organization 5 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Organization/ProviderOrganization6: name: Provider Organization 6 description: Provider Organization 6 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Organization/ProviderTransportationOrganization1: name: Provider Transportation Organization Example 1 description: Provider Transportation Organization Example 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Organization/Payer1: name: Payer 1 description: Payer 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Organization/Payer2: name: Payer 2 description: Payer 2 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Organization/DentalPayer1: name: Dental Payer1 description: Dental Payer1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization Practitioner/Practitioner1: name: Practitioner Example 1 description: Practitioner Example 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner Practitioner/Practitioner2: name: Practitioner Example 2 description: Practitioner Example 2 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner Practitioner/Practitioner3: name: Practitioner Example 3 description: Practitioner Example 3 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner Practitioner/PractitionerDentalProvider1: name: Dental Provider 1 description: Dental Provider 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner RelatedPerson/RelatedPerson1: name: Related Person 1 description: Related Person 1 exampleCanonical: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson