Skip to content

Commit

Permalink
Adjust description formatting in generator files so that markdown for…
Browse files Browse the repository at this point in the history
…matting for description section is fixed
  • Loading branch information
emichaud998 committed Nov 1, 2023
1 parent 3338c81 commit 1d7c3a6
Show file tree
Hide file tree
Showing 436 changed files with 3,167 additions and 3,058 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ module CARIN4BBV110
class C4BBTestKit < Inferno::TestSuite
title 'CARIN IG for Blue Button® v1.1.0'
description %(
The CARIN for Blue Button test suite validates system conformance to the HL7® FHIR® [CARIN for Blue Button® Implementation Guide](http://hl7.org/fhir/us/carin-bb/STU1.1).
The CARIN for Blue Button test suite validates system conformance to the HL7® FHIR® [CARIN for Blue Button® Implementation Guide](http://hl7.org/fhir/us/carin-bb/STU1.1).
)
version VERSION
links [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class CoverageMustSupportTest < Inferno::Test
Statement. This test will look through the Coverage resources
found previously for the following must support elements:
* Coverage.beneficiary
* Coverage.beneficiary
* Coverage.class
* Coverage.class.name
* Coverage.class.value
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@ class CoverageValidationTest < Inferno::Test

id :c4bb_v110_coverage_validation_test
title 'Coverage resources returned during previous tests conform to the C4BB Coverage'
description %(
This test verifies resources returned from the first search conform to
the [C4BB Coverage](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage).
Systems must demonstrate at least one valid example in order to pass this test.
description %(This test verifies resources returned from the first search conform to
the [C4BB Coverage](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage).
Systems must demonstrate at least one valid example in order to pass this test.
It verifies the presence of mandatory elements and that elements with
required bindings contain appropriate values. CodeableConcept element
bindings will fail if none of their codings have a code/system belonging
to the bound ValueSet. Quantity, Coding, and code element bindings will
fail if their code/system are not found in the valueset.
It verifies the presence of mandatory elements and that elements with
required bindings contain appropriate values. CodeableConcept element
bindings will fail if none of their codings have a code/system belonging
to the bound ValueSet. Quantity, Coding, and code element bindings will
fail if their code/system are not found in the valueset.
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,37 @@ module CARIN4BBV110
class CoverageGroup < Inferno::TestGroup
title 'Coverage Tests'
short_description 'Verify support for the server capabilities required by the C4BB Coverage.'
description %(
# Background
The CARIN for Blue Button Coverage sequence verifies that the system under test is
able to provide correct responses for Coverage queries. These queries
must contain resources conforming to the C4BB Coverage as
specified in the CARIN for Blue Button v1.1.0 Implementation Guide.
# Testing Methodology
## Must Support
Each profile contains elements marked as "must support". This test
sequence expects to see each of these elements at least once. If at
least one cannot be found, the test will fail. The test will look
through the Coverage resources found in the first test for these
elements.
## Profile Validation
Each resource returned from the first search is expected to conform to
the [C4BB Coverage](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage). Each element is checked against
terminology binding and cardinality requirements.
Elements with a required binding are validated against their bound
ValueSet. If the code/system in the element is not part of the ValueSet,
then the test will fail.
## Reference Validation
At least one instance of each external reference in elements marked as
"must support" within the resources provided by the system must resolve.
The test will attempt to read each reference found and will fail if no
read succeeds.
description %(# Background
The CARIN for Blue Button Coverage sequence verifies that the system under test is
able to provide correct responses for Coverage queries. These queries
must contain resources conforming to the C4BB Coverage as
specified in the CARIN for Blue Button v1.1.0 Implementation Guide.
# Testing Methodology
## Must Support
Each profile contains elements marked as "must support". This test
sequence expects to see each of these elements at least once. If at
least one cannot be found, the test will fail. The test will look
through the Coverage resources found in the first test for these
elements.
## Profile Validation
Each resource returned from the first search is expected to conform to
the [C4BB Coverage](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage). Each element is checked against
terminology binding and cardinality requirements.
Elements with a required binding are validated against their bound
ValueSet. If the code/system in the element is not part of the ValueSet,
then the test will fail.
## Reference Validation
At least one instance of each external reference in elements marked as
"must support" within the resources provided by the system must resolve.
The test will attempt to read each reference found and will fail if no
read succeeds.
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ class ExplanationOfBenefitExplanationOfBenefit_AllSearchTest < Inferno::Test
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by id + _include=ExplanationOfBenefit:*'
description %(
Tests that the server responds correctly when using _include="ExplanationOfBenefit:*" as a search parameter
description %(Tests that the server responds correctly when using _include="ExplanationOfBenefit:*" as a search parameter
)

def self.properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ class ExplanationOfBenefitExplanationOfBenefit_careteamSearchTest < Inferno::Tes
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by id + _include=ExplanationOfBenefit:care-team'
description %(
Tests that the server responds correctly when using _include="ExplanationOfBenefit:care-team" as a search parameter
description %(Tests that the server responds correctly when using _include="ExplanationOfBenefit:care-team" as a search parameter
)

def self.properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ class ExplanationOfBenefitExplanationOfBenefit_coverageSearchTest < Inferno::Tes
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by id + _include=ExplanationOfBenefit:coverage'
description %(
Tests that the server responds correctly when using _include="ExplanationOfBenefit:coverage" as a search parameter
description %(Tests that the server responds correctly when using _include="ExplanationOfBenefit:coverage" as a search parameter
)

def self.properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ class ExplanationOfBenefitExplanationOfBenefit_insurerSearchTest < Inferno::Test
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by id + _include=ExplanationOfBenefit:insurer'
description %(
Tests that the server responds correctly when using _include="ExplanationOfBenefit:insurer" as a search parameter
description %(Tests that the server responds correctly when using _include="ExplanationOfBenefit:insurer" as a search parameter
)

def self.properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ class ExplanationOfBenefitExplanationOfBenefit_patientSearchTest < Inferno::Test
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by id + _include=ExplanationOfBenefit:patient'
description %(
Tests that the server responds correctly when using _include="ExplanationOfBenefit:patient" as a search parameter
description %(Tests that the server responds correctly when using _include="ExplanationOfBenefit:patient" as a search parameter
)

def self.properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ class ExplanationOfBenefitExplanationOfBenefit_providerSearchTest < Inferno::Tes
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by id + _include=ExplanationOfBenefit:provider'
description %(
Tests that the server responds correctly when using _include="ExplanationOfBenefit:provider" as a search parameter
description %(Tests that the server responds correctly when using _include="ExplanationOfBenefit:provider" as a search parameter
)

def self.properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,20 @@ class ExplanationOfBenefitIdSearchTest < Inferno::Test
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by _id'
description %(
A server SHALL support searching by
_id on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
Because this is the first search of the sequence, resources in the
response will be used for subsequent tests.
Additionally, this test will check that GET and POST search methods
return the same number of results. Search by POST is required by the
FHIR R4 specification, and these tests interpret search by GET as a
requirement of CARIN IG for Blue Button® v1.1.0.
description %(A server SHALL support searching by
_id on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
Because this is the first search of the sequence, resources in the
response will be used for subsequent tests.
Additionally, this test will check that GET and POST search methods
return the same number of results. Search by POST is required by the
FHIR R4 specification, and these tests interpret search by GET as a
requirement of CARIN IG for Blue Button® v1.1.0.
)

id :c4bb_v110_explanation_of_benefit__id_search_test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ class ExplanationOfBenefitIdentifierSearchTest < Inferno::Test
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by identifier'
description %(
A server SHALL support searching by
identifier on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
description %(A server SHALL support searching by
identifier on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
)

id :c4bb_v110_explanation_of_benefit_identifier_search_test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ class ExplanationOfBenefitLastupdatedSearchTest < Inferno::Test
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by _lastUpdated'
description %(
A server SHALL support searching by
_lastUpdated on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
description %(A server SHALL support searching by
_lastUpdated on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
)

id :c4bb_v110_explanation_of_benefit__lastUpdated_search_test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class ExplanationOfBenefitMustSupportTest < Inferno::Test
Statement. This test will look through the ExplanationOfBenefit resources
found previously for the following must support elements:
* ExplanationOfBenefit.billablePeriod
* ExplanationOfBenefit.billablePeriod
* ExplanationOfBenefit.careTeam
* ExplanationOfBenefit.careTeam.provider
* ExplanationOfBenefit.careTeam.role
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ class ExplanationOfBenefitPatientSearchTest < Inferno::Test
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by patient'
description %(
A server SHALL support searching by
patient on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
description %(A server SHALL support searching by
patient on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
)

id :c4bb_v110_explanation_of_benefit_patient_search_test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ class ExplanationOfBenefitServiceDateSearchTest < Inferno::Test
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by service-date'
description %(
A server SHALL support searching by
service-date on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
description %(A server SHALL support searching by
service-date on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
)

id :c4bb_v110_explanation_of_benefit_service_date_search_test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ class ExplanationOfBenefitTypeSearchTest < Inferno::Test
include CarinForBlueButtonTestKit::CarinSearchTest

title 'Server returns valid results for ExplanationOfBenefit search by type'
description %(
A server SHALL support searching by
type on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
description %(A server SHALL support searching by
type on the ExplanationOfBenefit resource. This test
will pass if resources are returned and match the search criteria. If
none are returned, the test is skipped.
)

id :c4bb_v110_explanation_of_benefit_type_search_test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ class ExplanationOfBenefitValidationTest < Inferno::Test

id :c4bb_v110_explanation_of_benefit_validation_test
title 'ExplanationOfBenefit resources returned during previous tests conform to the C4BB Explanation Of Benefit'
description %(
This test verifies resources returned from the first search conform to
the [C4BB Explanation Of Benefit](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit).
Systems must demonstrate at least one valid example in order to pass this test.
description %(This test verifies resources returned from the first search conform to
the [C4BB Explanation Of Benefit](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit).
Systems must demonstrate at least one valid example in order to pass this test.
It verifies the presence of mandatory elements and that elements with
required bindings contain appropriate values. CodeableConcept element
bindings will fail if none of their codings have a code/system belonging
to the bound ValueSet. Quantity, Coding, and code element bindings will
fail if their code/system are not found in the valueset.
It verifies the presence of mandatory elements and that elements with
required bindings contain appropriate values. CodeableConcept element
bindings will fail if none of their codings have a code/system belonging
to the bound ValueSet. Quantity, Coding, and code element bindings will
fail if their code/system are not found in the valueset.
)

output :dar_code_found, :dar_extension_found
Expand Down
Loading

0 comments on commit 1d7c3a6

Please sign in to comment.