Measurereport.shex

ShEx statement for measurereport

PREFIX fhir: <http://hl7.org/fhir/> 
PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> 
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> 
IMPORT <code.shex>

# ShEx Version 2.2
IMPORT <Code.shex>

IMPORT <List.shex>
IMPORT <Group.shex>
IMPORT <Range.shex>
IMPORT <Ratio.shex>

IMPORT <Device.shex>
IMPORT <Period.shex>
IMPORT <string.shex>

IMPORT <String.shex>

IMPORT <Patient.shex>
IMPORT <boolean.shex>
IMPORT <integer.shex>

IMPORT <Integer.shex>
IMPORT <Boolean.shex>

IMPORT <CareTeam.shex>
IMPORT <Location.shex>
IMPORT <dateTime.shex>

IMPORT <DateTime.shex>
IMPORT <Markdown.shex>

IMPORT <Quantity.shex>
IMPORT <Duration.shex>
IMPORT <Resource.shex>
IMPORT <canonical.shex>

IMPORT <Reference.shex>
IMPORT <Canonical.shex>

IMPORT <Identifier.shex>
IMPORT <Parameters.shex>
IMPORT <Organization.shex>
IMPORT <Practitioner.shex>
IMPORT <RelatedPerson.shex>
IMPORT <DomainResource.shex>
IMPORT <CodeableConcept.shex>
IMPORT <BackboneElement.shex>
IMPORT <OperationOutcome.shex>

IMPORT <PractitionerRole.shex>
IMPORT <HealthcareService.shex>
start=@<MeasureReport> AND {fhir:nodeRole [fhir:treeRoot]}
# Results of a measure evaluation
<MeasureReport> EXTENDS @<DomainResource> CLOSED {   
    a [fhir:MeasureReport]?;
    fhir:nodeRole [fhir:treeRoot]?;

    a [fhir:MeasureReport]?;fhir:nodeRole [fhir:treeRoot]?;

    fhir:identifier @<OneOrMore_Identifier>?;  # Additional identifier for the 
                                            # MeasureReport 
    fhir:status @<code> AND

    fhir:category @<CodeableConcept>?;      # The category of measure report 
                                            # instance this is (example codes 
                                            # include deqm, ra, vbp) 
    fhir:messages @<Reference> AND {fhir:l 
    			@<OperationOutcome> ? }?;  # Evaluation messages
    fhir:status @<Code> AND

    	{fhir:v @fhirvs:measure-report-status};  # complete | pending | error
    fhir:type @<code> AND

    fhir:type @<Code> AND

    	{fhir:v @fhirvs:measure-report-type};  # individual | subject-list | 
                                            # summary | data-exchange 
    fhir:dataUpdateType @<code> AND

    fhir:dataUpdateType @<Code> AND

    	{fhir:v @fhirvs:submit-data-update-type}?;  # incremental | snapshot
    fhir:measure @<canonical>?;             # What measure was calculated
    fhir:subject @<Reference> AND {fhir:link 

    fhir:measure @<Canonical>?;             # What measure was calculated
    fhir:subject @<Reference> AND {fhir:l 

    			@<CareTeam> OR 
    			@<Device> OR 
    			@<Group> OR 
    			@<HealthcareService> OR 
    			@<Location> OR 
    			@<Organization> OR 
    			@<Patient> OR 
    			@<Practitioner> OR 
    			@<PractitionerRole> OR 
    			@<RelatedPerson> ? }?;  # What individual(s) the report is 
                                            # for 
    fhir:date @<dateTime>?;                 # When the measure was calculated
    fhir:reporter @<Reference> AND {fhir:link 
    			@<Group> OR 

    fhir:date @<DateTime>?;                 # When the measure report was 
                                            # generated 
    fhir:reporter @<Reference> AND {fhir:l 

    			@<Organization> OR 
    			@<Practitioner> OR 
    			@<PractitionerRole> ? }?;  # Who is reporting the data
    fhir:reportingVendor @<Reference> AND {fhir:link 

    fhir:reportingVendor @<Reference> AND {fhir:l 

    			@<Organization> ? }?;  # What vendor prepared the data
    fhir:location @<Reference> AND {fhir:link 
    			@<Location> ? }?;  # Where the reported data is from

    fhir:location @<OneOrMore_Reference_Location>?;  # Where the reported data is from

    fhir:period @<Period>;                  # What period the report covers
    fhir:inputParameters @<Reference> AND {fhir:link 

    fhir:inputParameters @<Reference> AND {fhir:l 

    			@<Parameters> ? }?;  # What parameters were provided to 
                                            # the report 
    fhir:scoring @<CodeableConcept>?;       # What scoring method (e.g. 
                                            # proportion, ratio, 
                                            # continuous-variable) 
    fhir:improvementNotation @<CodeableConcept>?;  # increase | decrease

    fhir:group @<OneOrMore_MeasureReport.group>?;  # Measure results for each group
    fhir:supplementalData @<OneOrMore_Reference_Resource>?;  # Additional information collected 
                                            # for the report 
    fhir:evaluatedResource @<OneOrMore_Reference_Resource>?;  # What data was used to calculate 
                                            # the measure score 
}  
# Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components
<MeasureReport.group.stratifier.stratum> EXTENDS @<BackboneElement> CLOSED {   
    fhir:value @<CodeableConcept>  OR 
    			@<boolean>  OR 
    			@<Quantity>  OR 
    			@<Range>  OR 
    			@<Reference>  ?;  # The stratum value, e.g. male
    fhir:component @<OneOrMore_MeasureReport.group.stratifier.stratum.component>?;  # Stratifier component values
    fhir:population @<OneOrMore_MeasureReport.group.stratifier.stratum.population>?;  # Population results in this stratum
    fhir:measureScore @<Quantity>  OR 
    			@<dateTime>  OR 
    			@<CodeableConcept>  OR 
    			@<Period>  OR 
    			@<Range>  OR 
    			@<Duration>  ?;  # What score this stratum achieved

# Stratification results
<MeasureReport.group.stratifier> EXTENDS @<BackboneElement> CLOSED {   
    fhir:linkId @<String>?;                 # Pointer to specific stratifier 
                                            # from Measure 
    fhir:title @<String>?;                  # Title of a group's stratifier. 
                                            # Note- this value is copied from 
                                            # this element in Measure 
    fhir:code @<CodeableConcept>?;          # What stratifier of the group
    fhir:description @<Markdown>?;          # The human readable description of 
                                            # this stratifier 
    fhir:stratum @<OneOrMore_MeasureReport.group.stratifier.stratum>?;  # Stratum results, one for each 
                                            # unique value, or set of values, in 
                                            # the stratifier, or stratifier 
                                            # components 

}  
# The populations in the group
<MeasureReport.group.population> EXTENDS @<BackboneElement> CLOSED {   
    fhir:linkId @<string>?;                 # Pointer to specific population 

    fhir:linkId @<String>?;                 # Pointer to specific population 

                                            # from Measure 
    fhir:title @<String>?;                  # Title of a group. Note- this value 
                                            # is copied from this element in 
                                            # Measure 

    fhir:code @<CodeableConcept>?;          # initial-population | numerator | 
                                            # numerator-exclusion | denominator 
                                            # | denominator-exclusion | 
                                            # denominator-exception | 
                                            # measure-population | 
                                            # measure-population-exclusion | 
                                            # measure-observation 
    fhir:count @<integer>?;                 # Size of the population
    fhir:subjectResults @<Reference> AND {fhir:link 

    fhir:description @<Markdown>?;          # The human readable description of 
                                            # this population criteria 
    fhir:count @<Integer>?;                 # Size of the population
    fhir:countQuantity @<Quantity>?;        # Size of the population as a 
                                            # quantity 
    fhir:subjectResults @<Reference> AND {fhir:l 

    			@<List> ? }?;  # For subject-list reports, the 
                                            # subject results in this population 
    fhir:subjectReport @<OneOrMore_Reference_MeasureReport>?;  # For subject-list reports, a 
                                            # subject result in this population 
    fhir:subjects @<Reference> AND {fhir:link 

    fhir:subjectReport @<OneOrMore_Reference_MeasureReport>?;  # For subject-list reports, 
                                            # references to the individual 
                                            # reports for subjects in this 
                                            # population 
    fhir:subjects @<Reference> AND {fhir:l 

    			@<Group> ? }?;  # What individual(s) in the 
                                            # population 
}  
# Stratification results
<MeasureReport.group.stratifier> EXTENDS @<BackboneElement> CLOSED {   
    fhir:linkId @<string>?;                 # Pointer to specific stratifier 
                                            # from Measure 
    fhir:code @<CodeableConcept>?;          # What stratifier of the group
    fhir:stratum @<OneOrMore_MeasureReport.group.stratifier.stratum>?;  # Stratum results, one for each 
                                            # unique value, or set of values, in 
                                            # the stratifier, or stratifier 
                                            # components 
}  
# Stratifier component values
<MeasureReport.group.stratifier.stratum.component> EXTENDS @<BackboneElement> CLOSED {   
    fhir:linkId @<string>?;                 # Pointer to specific stratifier 
                                            # component from Measure 
    fhir:code @<CodeableConcept>;           # What stratifier component of the 
                                            # group 
    fhir:value @<CodeableConcept>  OR 
    			@<boolean>  OR 
    			@<Quantity>  OR 
    			@<Range>  OR 
    			@<Reference>  ;  # The stratum component value, e.g. 
                                            # male 
}  

# Population results in this stratum
<MeasureReport.group.stratifier.stratum.population> EXTENDS @<BackboneElement> CLOSED {   
    fhir:linkId @<string>?;                 # Pointer to specific population 

    fhir:linkId @<String>?;                 # Pointer to specific population 

                                            # from Measure 
    fhir:code @<CodeableConcept>?;          # initial-population | numerator | 
                                            # numerator-exclusion | denominator 
                                            # | denominator-exclusion | 
                                            # denominator-exception | 
                                            # measure-population | 
                                            # measure-population-exclusion | 
                                            # measure-observation 
    fhir:count @<integer>?;                 # Size of the population
    fhir:subjectResults @<Reference> AND {fhir:link 

    fhir:count @<Integer>?;                 # Size of the population
    fhir:countQuantity @<Quantity>?;        # Size of the population as a 
                                            # quantity 
    fhir:subjectResults @<Reference> AND {fhir:l 

    			@<List> ? }?;  # For subject-list reports, the 
                                            # subject results in this population 
    fhir:subjectReport @<OneOrMore_Reference_MeasureReport>?;  # For subject-list reports, a 
                                            # subject result in this population 
    fhir:subjects @<Reference> AND {fhir:link 

    fhir:subjects @<Reference> AND {fhir:l 

    			@<Group> ? }?;  # What individual(s) in the 
                                            # population 
}  
# Stratifier component values
<MeasureReport.group.stratifier.stratum.component> EXTENDS @<BackboneElement> CLOSED {   
    fhir:linkId @<String>?;                 # Pointer to specific stratifier 
                                            # component from Measure 
    fhir:code @<CodeableConcept>;           # What stratifier component of the 
                                            # group 
    fhir:description @<Markdown>?;          # The human readable description of 
                                            # this stratifier component 
    fhir:value @<CodeableConcept>  OR 
    			@<Boolean>  OR 
    			@<Quantity>  OR 
    			@<Range>  OR 
    			@<Reference>  ;  # The stratum component value, e.g. 
                                            # male 
}  
# Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components
<MeasureReport.group.stratifier.stratum> EXTENDS @<BackboneElement> CLOSED {   
    fhir:value @<CodeableConcept>  OR 
    			@<Boolean>  OR 
    			@<Quantity>  OR 
    			@<Range>  OR 
    			@<Reference>  ?;  # The stratum value, e.g. male
    fhir:component @<OneOrMore_MeasureReport.group.stratifier.stratum.component>?;  # Stratifier component values
    fhir:population @<OneOrMore_MeasureReport.group.stratifier.stratum.population>?;  # Population results in this stratum
    fhir:measureScore @<Quantity>  OR 
    			@<DateTime>  OR 
    			@<CodeableConcept>  OR 
    			@<Period>  OR 
    			@<Range>  OR 
    			@<Duration>  OR 
    			@<Boolean>  OR 
    			@<Ratio>  ?;  # What score this stratum achieved
}  

# Measure results for each group
<MeasureReport.group> EXTENDS @<BackboneElement> CLOSED {   
    fhir:linkId @<string>?;                 # Pointer to specific group from 

    fhir:linkId @<String>?;                 # Pointer to specific group from 
                                            # Measure 
    fhir:title @<String>?;                  # Title of a group. Note- this value 
                                            # is copied from this element in 

                                            # Measure 
    fhir:calculatedDate @<DateTime>?;       # The date the Measure Report was 
                                            # calculated 

    fhir:code @<CodeableConcept>?;          # Meaning of the group
    fhir:subject @<Reference> AND {fhir:link 

    fhir:description @<Markdown>?;          # Summary description
    fhir:type @<CodeableConcept>?;          # process | outcome | structure | 
                                            # patient-reported-outcome 
    fhir:subject @<Reference> AND {fhir:l 

    			@<CareTeam> OR 
    			@<Device> OR 
    			@<Group> OR 
    			@<HealthcareService> OR 
    			@<Location> OR 
    			@<Organization> OR 
    			@<Patient> OR 
    			@<Practitioner> OR 
    			@<PractitionerRole> OR 
    			@<RelatedPerson> ? }?;  # What individual(s) the report is 
                                            # for 
    fhir:scoring @<CodeableConcept>?;       # What scoring method (e.g. 
                                            # proportion, ratio, 
                                            # continuous-variable) 
    fhir:improvementNotation @<CodeableConcept>?;  # increase | decrease
    fhir:improvementNotationGuidance @<Markdown>?;  # Explanation of improvement notation

    fhir:population @<OneOrMore_MeasureReport.group.population>?;  # The populations in the group
    fhir:measureScore @<Quantity>  OR 
    			@<dateTime>  OR 

    			@<DateTime>  OR 

    			@<CodeableConcept>  OR 
    			@<Period>  OR 
    			@<Range>  OR 
    			@<Duration>  ?;  # What score this group achieved

    			@<Duration>  OR 
    			@<Boolean>  OR 
    			@<Ratio>  ?;  # What score this group achieved

    fhir:stratifier @<OneOrMore_MeasureReport.group.stratifier>?;  # Stratification results
}  
#---------------------- Cardinality Types (OneOrMore) -------------------
<OneOrMore_Identifier> CLOSED {
    rdf:first @<Identifier>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Identifier> 
}
<OneOrMore_Reference_Location> CLOSED {
    rdf:first @<Reference> AND {fhir:l 
			@<Location> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Location> 
}

<OneOrMore_MeasureReport.group> CLOSED {
    rdf:first @<MeasureReport.group>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_MeasureReport.group> 
}
<OneOrMore_Reference_Resource> CLOSED {
    rdf:first @<Reference> AND {fhir:link 

    rdf:first @<Reference> AND {fhir:l 

			@<Resource> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Resource> 
}
<OneOrMore_MeasureReport.group.stratifier.stratum> CLOSED {
    rdf:first @<MeasureReport.group.stratifier.stratum>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_MeasureReport.group.stratifier.stratum> 
}
<OneOrMore_Reference_MeasureReport> CLOSED {
    rdf:first @<Reference> AND {fhir:l 
			@<MeasureReport> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_MeasureReport> 
}

<OneOrMore_MeasureReport.group.stratifier.stratum.component> CLOSED {
    rdf:first @<MeasureReport.group.stratifier.stratum.component>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_MeasureReport.group.stratifier.stratum.component> 
}
<OneOrMore_MeasureReport.group.stratifier.stratum.population> CLOSED {
    rdf:first @<MeasureReport.group.stratifier.stratum.population>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_MeasureReport.group.stratifier.stratum.population> 
}
<OneOrMore_Reference_MeasureReport> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<MeasureReport> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_MeasureReport> 
}
<OneOrMore_MeasureReport.group.stratifier.stratum> CLOSED {
    rdf:first @<MeasureReport.group.stratifier.stratum>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_MeasureReport.group.stratifier.stratum> 
}

<OneOrMore_MeasureReport.group.population> CLOSED {
    rdf:first @<MeasureReport.group.population>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_MeasureReport.group.population> 
}
<OneOrMore_MeasureReport.group.stratifier> CLOSED {
    rdf:first @<MeasureReport.group.stratifier>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_MeasureReport.group.stratifier> 
}
#---------------------- Value Sets ------------------------
# The status of the measure report.
fhirvs:measure-report-status ["complete" "pending" "error"]
# The type of the measure report.
fhirvs:measure-report-type ["individual" "subject-list" "summary" "data-exchange"]
# Concepts for how a measure report consumer and receiver coordinate data exchange updates. The choices are snapshot or incremental updates
fhirvs:submit-data-update-type ["incremental" "snapshot"]