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#>
BASE <http://hl7.org/fhir/shape/>
start=@<MeasureReport> AND {fhir:nodeRole [fhir:treeRoot]}
# Results of a measure evaluation
<MeasureReport> CLOSED {
a [fhir:MeasureReport];
fhir:nodeRole [fhir:treeRoot]?;
fhir:Resource.id @<id>?; # Logical id of this artifact
fhir:Resource.meta @<Meta>?; # Metadata about the resource
fhir:Resource.implicitRules @<uri>?; # A set of rules under which this
# content was created
fhir:Resource.language @<code>?; # Language of the resource content
fhir:DomainResource.text @<Narrative>?; # Text summary of the resource, for
# human interpretation
fhir:DomainResource.contained @<Resource>*; # Contained, inline Resources
fhir:DomainResource.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:DomainResource.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:MeasureReport.identifier @<Identifier>?; # Additional identifier for the
# Report
fhir:MeasureReport.status @<code> AND
{fhir:value @fhirvs:measure-report-status}; # complete | pending | error
fhir:MeasureReport.type @<code> AND
{fhir:value @fhirvs:measure-report-type}; # individual | patient-list | summary
fhir:MeasureReport.measure @<Reference>; # What measure was evaluated
fhir:MeasureReport.patient @<Reference>?; # What patient the report is for
fhir:MeasureReport.date @<dateTime>?; # When the report was generated
fhir:MeasureReport.reportingOrganization @<Reference>?; # Who is reporting the data
fhir:MeasureReport.period @<Period>; # What period the report covers
fhir:MeasureReport.group @<MeasureReport.group>*; # Measure results for each group
fhir:MeasureReport.evaluatedResources @<Reference>?; # What data was evaluated to produce
# the measure score
fhir:index xsd:integer? # Relative position in a list
}
# Measure results for each group
<MeasureReport.group> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:MeasureReport.group.identifier @<Identifier>; # What group of the measure
fhir:MeasureReport.group.population @<MeasureReport.group.population>*; # The populations in the group
fhir:MeasureReport.group.measureScore @<decimal>?; # What score this group achieved
fhir:MeasureReport.group.stratifier @<MeasureReport.group.stratifier>*; # Stratification results
fhir:index xsd:integer? # Relative position in a list
}
# The populations in the group
<MeasureReport.group.population> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:MeasureReport.group.population.identifier @<Identifier>?; # Population identifier as defined
# in the measure
fhir:MeasureReport.group.population.code @<CodeableConcept>?; # initial-population | numerator |
# numerator-exclusion | denominator
# | denominator-exclusion |
# denominator-exception |
# measure-population |
# measure-population-exclusion |
# measure-score
fhir:MeasureReport.group.population.count @<integer>?; # Size of the population
fhir:MeasureReport.group.population.patients @<Reference>?; # For patient-list reports, the
# patients in this population
fhir:index xsd:integer? # Relative position in a list
}
# Stratification results
<MeasureReport.group.stratifier> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:MeasureReport.group.stratifier.identifier @<Identifier>?; # What stratifier of the group
fhir:MeasureReport.group.stratifier.stratum @<MeasureReport.group.stratifier.stratum>*; # Stratum results, one for each
# unique value in the stratifier
fhir:index xsd:integer? # Relative position in a list
}
# Stratum results, one for each unique value in the stratifier
<MeasureReport.group.stratifier.stratum> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:MeasureReport.group.stratifier.stratum.value @<string>; # The stratum value, e.g. male
fhir:MeasureReport.group.stratifier.stratum.population @<MeasureReport.group.stratifier.stratum.population>*; # Population results in this stratum
fhir:MeasureReport.group.stratifier.stratum.measureScore @<decimal>?; # What score this stratum achieved
fhir:index xsd:integer? # Relative position in a list
}
# Population results in this stratum
<MeasureReport.group.stratifier.stratum.population> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:MeasureReport.group.stratifier.stratum.population.identifier @<Identifier>?; # Population identifier as defined
# in the measure
fhir:MeasureReport.group.stratifier.stratum.population.code @<CodeableConcept>?; # initial-population | numerator |
# numerator-exclusion | denominator
# | denominator-exclusion |
# denominator-exception |
# measure-population |
# measure-population-exclusion |
# measure-score
fhir:MeasureReport.group.stratifier.stratum.population.count @<integer>?; # Size of the population
fhir:MeasureReport.group.stratifier.stratum.population.patients @<Reference>?; # For patient-list reports, the
# patients in this population
fhir:index xsd:integer? # Relative position in a list
}
#---------------------- Data Types -------------------
# Primitive Type dateTime
<dateTime> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:gYear OR xsd:gYearMonth OR xsd:date OR xsd:dateTime?; # Primitive value for dateTime
fhir:index xsd:integer? # Relative position in a list
}
# Metadata about a resource
<Meta> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Meta.versionId @<id>?; # Version specific identifier
fhir:Meta.lastUpdated @<instant>?; # When the resource version last
# changed
fhir:Meta.profile @<uri>*; # Profiles this resource claims to
# conform to
fhir:Meta.security @<Coding>*; # Security Labels applied to this
# resource
fhir:Meta.tag @<Coding>*; # Tags applied to this resource
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type code
<code> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:string?; # Primitive value for code
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type string
<string> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:string MAXLENGTH 1048576?; # Primitive value for string
fhir:index xsd:integer? # Relative position in a list
}
# A reference from one resource to another
<Reference> CLOSED {
fhir:link IRI?;
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Reference.reference @<string>?; # Literal reference, Relative,
# internal or absolute URL
fhir:Reference.identifier @<Identifier>?; # Logical reference, when literal
# reference is not known
fhir:Reference.display @<string>?; # Text alternative for the resource
fhir:index xsd:integer? # Relative position in a list
}
# Base Resource
<Resource> {a .+;
fhir:Resource.id @<id>?; # Logical id of this artifact
fhir:Resource.meta @<Meta>?; # Metadata about the resource
fhir:Resource.implicitRules @<uri>?; # A set of rules under which this
# content was created
fhir:Resource.language @<code>?; # Language of the resource content
fhir:index xsd:integer?
}
# Time range defined by start and end date/time
<Period> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Period.start @<dateTime>?; # Starting time with inclusive
# boundary
fhir:Period.end @<dateTime>?; # End time with inclusive boundary,
# if not ongoing
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type integer
<integer> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:integer MININCLUSIVE "-2147483648"^^xsd:integer MAXINCLUSIVE "2147483647"^^xsd:integer?; # Primitive value for integer
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type uri
<uri> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:string?; # Primitive value for uri
fhir:index xsd:integer? # Relative position in a list
}
# Optional Extensions Element
<Extension> CLOSED {
fhir:Element.id @<string>?;
fhir:Element.extension @<Extension>*;
fhir:Extension.url @<uri>;
(
fhir:Extension.valueBase64Binary @<base64Binary> |
fhir:Extension.valueBoolean @<boolean> |
fhir:Extension.valueCode @<code> |
fhir:Extension.valueDate @<date> |
fhir:Extension.valueDateTime @<dateTime> |
fhir:Extension.valueDecimal @<decimal> |
fhir:Extension.valueId @<id> |
fhir:Extension.valueInstant @<instant> |
fhir:Extension.valueInteger @<integer> |
fhir:Extension.valueMarkdown @<markdown> |
fhir:Extension.valueOid @<oid> |
fhir:Extension.valuePositiveInt @<positiveInt> |
fhir:Extension.valueString @<string> |
fhir:Extension.valueTime @<time> |
fhir:Extension.valueUnsignedInt @<unsignedInt> |
fhir:Extension.valueUri @<uri> |
fhir:Extension.valueAddress @<Address> |
fhir:Extension.valueAge @<Age> |
fhir:Extension.valueAnnotation @<Annotation> |
fhir:Extension.valueAttachment @<Attachment> |
fhir:Extension.valueCodeableConcept @<CodeableConcept> |
fhir:Extension.valueCoding @<Coding> |
fhir:Extension.valueContactPoint @<ContactPoint> |
fhir:Extension.valueCount @<Count> |
fhir:Extension.valueDistance @<Distance> |
fhir:Extension.valueDuration @<Duration> |
fhir:Extension.valueHumanName @<HumanName> |
fhir:Extension.valueIdentifier @<Identifier> |
fhir:Extension.valueMoney @<Money> |
fhir:Extension.valuePeriod @<Period> |
fhir:Extension.valueQuantity @<Quantity> |
fhir:Extension.valueRange @<Range> |
fhir:Extension.valueRatio @<Ratio> |
fhir:Extension.valueReference @<Reference> |
fhir:Extension.valueSampledData @<SampledData> |
fhir:Extension.valueSignature @<Signature> |
fhir:Extension.valueTiming @<Timing> |
fhir:Extension.valueMeta @<Meta>
)?;
fhir:index xsd:integer? # Relative position in a list
}
# An identifier intended for computation
<Identifier> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Identifier.use @<code> AND
{fhir:value @fhirvs:identifier-use}?; # usual | official | temp |
# secondary (If known)
fhir:Identifier.type @<CodeableConcept>?; # Description of identifier
fhir:Identifier.system @<uri>?; # The namespace for the identifier
# value
fhir:Identifier.value @<string>?; # The value that is unique
fhir:Identifier.period @<Period>?; # Time period when id is/was valid
# for use
fhir:Identifier.assigner @<Reference>?; # Organization that issued id (may
# be just text)
fhir:index xsd:integer? # Relative position in a list
}
# A human-readable formatted text, including images
<Narrative> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Narrative.status @<code> AND
{fhir:value @fhirvs:narrative-status}; # generated | extensions |
# additional | empty
fhir:Narrative.div xsd:string; # Limited xhtml content
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type id
<id> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:string?; # Primitive value for id
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type decimal
<decimal> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:decimal?; # Primitive value for decimal
fhir:index xsd:integer? # Relative position in a list
}
# Concept - reference to a terminology or just text
<CodeableConcept> CLOSED {
a NONLITERAL*;
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:CodeableConcept.coding @<Coding>*; # Code defined by a terminology
# system
fhir:CodeableConcept.text @<string>?; # Plain text representation of the
# concept
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type date
<date> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:gYear OR xsd:gYearMonth OR xsd:date?; # Primitive value for date
fhir:index xsd:integer? # Relative position in a list
}
# An address expressed using postal conventions (as opposed to GPS or other location definition formats)
<Address> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Address.use @<code> AND
{fhir:value @fhirvs:address-use}?; # home | work | temp | old - purpose
# of this address
fhir:Address.type @<code> AND
{fhir:value @fhirvs:address-type}?; # postal | physical | both
fhir:Address.text @<string>?; # Text representation of the address
fhir:Address.line @<string>*; # Street name, number, direction &
# P.O. Box etc.
fhir:Address.city @<string>?; # Name of city, town etc.
fhir:Address.district @<string>?; # District name (aka county)
fhir:Address.state @<string>?; # Sub-unit of country (abbreviations
# ok)
fhir:Address.postalCode @<string>?; # Postal code for area
fhir:Address.country @<string>?; # Country (e.g. can be ISO 3166 2 or
# 3 letter code)
fhir:Address.period @<Period>?; # Time period when address was/is in
# use
fhir:index xsd:integer? # Relative position in a list
}
# Content in a format defined elsewhere
<Attachment> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Attachment.contentType @<code>?; # Mime type of the content, with
# charset etc.
fhir:Attachment.language @<code>?; # Human language of the content
# (BCP-47)
fhir:Attachment.data @<base64Binary>?; # Data inline, base64ed
fhir:Attachment.url @<uri>?; # Uri where the data can be found
fhir:Attachment.size @<unsignedInt>?; # Number of bytes of content (if url
# provided)
fhir:Attachment.hash @<base64Binary>?; # Hash of the data (sha-1, base64ed)
fhir:Attachment.title @<string>?; # Label to display in place of the
# data
fhir:Attachment.creation @<dateTime>?; # Date attachment was first created
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type oid
<oid> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:string?; # Primitive value for oid
fhir:index xsd:integer? # Relative position in a list
}
# A measured or measurable amount
<Count> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type instant
<instant> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:dateTime?; # Primitive value for instant
fhir:index xsd:integer? # Relative position in a list
}
# Details of a Technology mediated contact point (phone, fax, email, etc.)
<ContactPoint> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:ContactPoint.system @<code> AND
{fhir:value @fhirvs:contact-point-system}?; # phone | fax | email | pager | url
# | sms | other
fhir:ContactPoint.value @<string>?; # The actual contact point details
fhir:ContactPoint.use @<code> AND
{fhir:value @fhirvs:contact-point-use}?; # home | work | temp | old | mobile
# - purpose of this contact point
fhir:ContactPoint.rank @<positiveInt>?; # Specify preferred order of use (1
# = highest)
fhir:ContactPoint.period @<Period>?; # Time period when the contact point
# was/is in use
fhir:index xsd:integer? # Relative position in a list
}
# Name of a human - parts and usage
<HumanName> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:HumanName.use @<code> AND
{fhir:value @fhirvs:name-use}?; # usual | official | temp | nickname
# | anonymous | old | maiden
fhir:HumanName.text @<string>?; # Text representation of the full
# name
fhir:HumanName.family @<string>?; # Family name (often called
# 'Surname')
fhir:HumanName.given @<string>*; # Given names (not always 'first').
# Includes middle names
fhir:HumanName.prefix @<string>*; # Parts that come before the name
fhir:HumanName.suffix @<string>*; # Parts that come after the name
fhir:HumanName.period @<Period>?; # Time period when name was/is in use
fhir:index xsd:integer? # Relative position in a list
}
# An amount of economic utility in some recognized currency
<Money> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A reference to a code defined by a terminology system
<Coding> CLOSED {
a NONLITERAL?;
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Coding.system @<uri>?; # Identity of the terminology system
fhir:Coding.version @<string>?; # Version of the system - if relevant
fhir:Coding.code @<code>?; # Symbol in syntax defined by the
# system
fhir:Coding.display @<string>?; # Representation defined by the
# system
fhir:Coding.userSelected @<boolean>?; # If this coding was chosen directly
# by the user
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type markdown
<markdown> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:string?; # Primitive value for markdown
fhir:index xsd:integer? # Relative position in a list
}
# A series of measurements taken by a device
<SampledData> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:SampledData.origin @<SimpleQuantity>; # Zero value and units
fhir:SampledData.period @<decimal>; # Number of milliseconds between
# samples
fhir:SampledData.factor @<decimal>?; # Multiply data by this before
# adding to origin
fhir:SampledData.lowerLimit @<decimal>?; # Lower limit of detection
fhir:SampledData.upperLimit @<decimal>?; # Upper limit of detection
fhir:SampledData.dimensions @<positiveInt>; # Number of sample points at each
# time point
fhir:SampledData.data @<string>; # Decimal values with spaces, or "E"
# | "U" | "L"
fhir:index xsd:integer? # Relative position in a list
}
# A ratio of two Quantity values - a numerator and a denominator
<Ratio> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Ratio.numerator @<Quantity>?; # Numerator value
fhir:Ratio.denominator @<Quantity>?; # Denominator value
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type positiveInt
<positiveInt> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:positiveInteger?; # Primitive value for positiveInt
fhir:index xsd:integer? # Relative position in a list
}
# A duration of time during which an organism (or a process) has existed
<Age> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A length - a value with a unit that is a physical distance
<Distance> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A measured or measurable amount
<Quantity> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A length of time
<Duration> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# Set of values bounded by low and high
<Range> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Range.low @<SimpleQuantity>?; # Low limit
fhir:Range.high @<SimpleQuantity>?; # High limit
fhir:index xsd:integer? # Relative position in a list
}
# Text node with attribution
<Annotation> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
( # Individual responsible for the
# annotation
fhir:Annotation.authorReference @<Reference> |
fhir:Annotation.authorReference @<Reference> |
fhir:Annotation.authorReference @<Reference> |
fhir:Annotation.authorString @<string>
)?;
fhir:Annotation.time @<dateTime>?; # When the annotation was made
fhir:Annotation.text @<string>; # The annotation - text content
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type boolean
<boolean> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:boolean?; # Primitive value for boolean
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type base64Binary
<base64Binary> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:base64Binary?; # Primitive value for base64Binary
fhir:index xsd:integer? # Relative position in a list
}
# A digital Signature - XML DigSig, JWT, Graphical image of signature, etc.
<Signature> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Signature.type @<Coding>+; # Indication of the reason the
# entity signed the object(s)
fhir:Signature.when @<instant>; # When the signature was created
( # Who signed
fhir:Signature.whoUri @<uri> |
fhir:Signature.whoReference @<Reference> |
fhir:Signature.whoReference @<Reference> |
fhir:Signature.whoReference @<Reference> |
fhir:Signature.whoReference @<Reference> |
fhir:Signature.whoReference @<Reference>
);
( # The party represented
fhir:Signature.onBehalfOfUri @<uri> |
fhir:Signature.onBehalfOfReference @<Reference> |
fhir:Signature.onBehalfOfReference @<Reference> |
fhir:Signature.onBehalfOfReference @<Reference> |
fhir:Signature.onBehalfOfReference @<Reference> |
fhir:Signature.onBehalfOfReference @<Reference>
)?;
fhir:Signature.contentType @<code>?; # The technical format of the
# signature
fhir:Signature.blob @<base64Binary>?; # The actual signature content (XML
# DigSig. JWT, picture, etc.)
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type unsignedInt
<unsignedInt> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:nonNegativeInteger?; # Primitive value for unsignedInt
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type time
<time> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:time?; # Primitive value for time
fhir:index xsd:integer? # Relative position in a list
}
# A timing schedule that specifies an event that may occur multiple times
<Timing> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Timing.event @<dateTime>*; # When the event occurs
fhir:Timing.repeat @<Timing.repeat>?; # When the event is to occur
fhir:Timing.code @<CodeableConcept>?; # BID | TID | QID | AM | PM | QD |
# QOD | Q4H | Q6H +
fhir:index xsd:integer? # Relative position in a list
}
# A fixed quantity (no comparator)
<SimpleQuantity> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# When the event is to occur
<Timing.repeat> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
( # Length/Range of lengths, or (Start
# and/or end) limits
fhir:Timing.repeat.boundsDuration @<Duration> |
fhir:Timing.repeat.boundsRange @<Range> |
fhir:Timing.repeat.boundsPeriod @<Period>
)?;
fhir:Timing.repeat.count @<integer>?; # Number of times to repeat
fhir:Timing.repeat.countMax @<integer>?; # Maximum number of times to repeat
fhir:Timing.repeat.duration @<decimal>?; # How long when it happens
fhir:Timing.repeat.durationMax @<decimal>?; # How long when it happens (Max)
fhir:Timing.repeat.durationUnit @<code> AND
{fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a -
# unit of time (UCUM)
fhir:Timing.repeat.frequency @<integer>?; # Event occurs frequency times per
# period
fhir:Timing.repeat.frequencyMax @<integer>?; # Event occurs up to frequencyMax
# times per period
fhir:Timing.repeat.period @<decimal>?; # Event occurs frequency times per
# period
fhir:Timing.repeat.periodMax @<decimal>?; # Upper limit of period (3-4 hours)
fhir:Timing.repeat.periodUnit @<code> AND
{fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a -
# unit of time (UCUM)
fhir:Timing.repeat.dayOfWeek @<code> AND
{fhir:value @fhirvs:days-of-week}*; # mon | tue | wed | thu | fri | sat
# | sun
fhir:Timing.repeat.timeOfDay @<time>*; # Time of day for action
fhir:Timing.repeat.when @<code> AND
{fhir:value @fhirvs:event-timing}*; # Regular life events the event is
# tied to
fhir:Timing.repeat.offset @<unsignedInt>?; # Minutes from event (before or
# after)
fhir:index xsd:integer? # Relative position in a list
}
#---------------------- Reference Types -------------------
#---------------------- Value Sets ------------------------
# The status of a resource narrative
fhirvs:narrative-status ["generated" "extensions" "additional" "empty"]
# Use of contact point
fhirvs:contact-point-use ["home" "work" "temp" "old" "mobile"]
# The days of the week.
fhirvs:days-of-week ["mon" "tue" "wed" "thu" "fri" "sat" "sun"]
# The status of the measure report
fhirvs:measure-report-status ["complete" "pending" "error"]
# How the Quantity should be understood and represented.
fhirvs:quantity-comparator ["<" "<=" ">=" ">"]
# The type of an address (physical / postal)
fhirvs:address-type ["postal" "physical" "both"]
# Real world event relating to the schedule.
fhirvs:event-timing ["MORN" "AFT" "EVE" "NIGHT" "PHS" "HS" "WAKE" "C" "CM" "CD" "CV" "AC" "ACM" "ACD" "ACV" "PC" "PCM" "PCD" "PCV"]
# The type of the measure report
fhirvs:measure-report-type ["individual" "patient-list" "summary"]
# Identifies the purpose for this identifier, if known .
fhirvs:identifier-use ["usual" "official" "temp" "secondary"]
# A unit of time (units from UCUM).
fhirvs:units-of-time ["s" "min" "h" "d" "wk" "mo" "a"]
# The use of an address
fhirvs:address-use ["home" "work" "temp" "old"]
# The use of a human name
fhirvs:name-use ["usual" "official" "temp" "nickname" "anonymous" "old" "maiden"]
# Telecommunications form for contact point
fhirvs:contact-point-system ["phone" "fax" "email" "pager" "url" "sms" "other"]
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#>
# 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 <Patient.shex>
IMPORT <Integer.shex>
IMPORT <Boolean.shex>
IMPORT <CareTeam.shex>
IMPORT <Location.shex>
IMPORT <DateTime.shex>
IMPORT <Markdown.shex>
IMPORT <Quantity.shex>
IMPORT <Duration.shex>
IMPORT <Resource.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]?;
fhir:identifier @<OneOrMore_Identifier>?; # Additional identifier for the
# MeasureReport
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:v @fhirvs:measure-report-type}; # individual | subject-list |
# summary | data-exchange
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: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 report was
# generated
fhir:reporter @<Reference> AND {fhir:l
@<Organization> OR
@<Practitioner> OR
@<PractitionerRole> ? }?; # Who is reporting the data
fhir:reportingVendor @<Reference> AND {fhir:l
@<Organization> ? }?; # What vendor prepared the data
fhir:location @<OneOrMore_Reference_Location>?; # Where the reported data is from
fhir:period @<Period>; # What period the report covers
fhir:inputParameters @<Reference> AND {fhir:l
@<Parameters> ? }?; # What parameters were provided to
# the report
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
}
# 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
}
# Population results in this stratum
<MeasureReport.group.stratifier.stratum.population> EXTENDS @<BackboneElement> CLOSED {
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: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:l
@<Group> ? }?; # What individual(s) in the
# population
}
# Measure results for each group
<MeasureReport.group> EXTENDS @<BackboneElement> CLOSED {
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: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
@<CodeableConcept> OR
@<Period> OR
@<Range> OR
@<Duration> OR
@<Boolean> OR
@<Ratio> ?; # What score this group achieved
fhir:stratifier @<OneOrMore_MeasureReport.group.stratifier>?; # Stratification results
}
# The populations in the group
<MeasureReport.group.population> EXTENDS @<BackboneElement> CLOSED {
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: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,
# references to the individual
# reports for subjects in this
# population
fhir:subjects @<Reference> AND {fhir:l
@<Group> ? }?; # What individual(s) in the
# population
}
# 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
}
# 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
}
#---------------------- 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: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.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>
}
<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>
}
#---------------------- 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"]
Usage
note:
every
effort
has
been
made
to
ensure
that
the
ShEx
files
are
correct
and
useful,
but
they
are
not
a
normative
part
of
the
specification.