Evidencevariable.shex

ShEx statement for evidencevariable

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 <id.shex>

IMPORT <uri.shex>
IMPORT <code.shex>
IMPORT <date.shex>
IMPORT <Range.shex>
IMPORT <Group.shex>
IMPORT <string.shex>
IMPORT <Coding.shex>
IMPORT <Period.shex>
IMPORT <Device.shex>

IMPORT <boolean.shex>
IMPORT <dateTime.shex>

IMPORT <markdown.shex>
IMPORT <dateTime.shex>

IMPORT <Quantity.shex>
IMPORT <Evidence.shex>

IMPORT <ValueSet.shex>
IMPORT <Resource.shex>

IMPORT <Reference.shex>
IMPORT <canonical.shex>
IMPORT <Identifier.shex>
IMPORT <Annotation.shex>
IMPORT <Expression.shex>
IMPORT <Attachment.shex>
IMPORT <unsignedInt.shex>

IMPORT <positiveInt.shex>
IMPORT <UsageContext.shex>
IMPORT <DeviceMetric.shex>

IMPORT <RelativeTime.shex>

IMPORT <ContactDetail.shex>
IMPORT <DomainResource.shex>
IMPORT <RelatedArtifact.shex>
IMPORT <BackboneElement.shex>

IMPORT <CodeableConcept.shex>
IMPORT <BackboneElement.shex>
IMPORT <CodeableReference.shex>

start=@<EvidenceVariable> AND {fhir:nodeRole [fhir:treeRoot]}
# A definition of an exposure, outcome, or other variable
<EvidenceVariable> EXTENDS @<DomainResource> CLOSED {   
    a [fhir:EvidenceVariable]?;
    fhir:nodeRole [fhir:treeRoot]?;

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

    fhir:url @<uri>?;                       # Canonical identifier for this 
                                            # evidence variable, represented as 
                                            # a URI (globally unique) 
    fhir:identifier @<OneOrMore_Identifier>?;  # Additional identifier for the 
                                            # evidence variable 
    fhir:version @<string>?;                # Business version of the evidence 
                                            # variable 
    fhir:versionAlgorithm @<string>  OR 
    			@<Coding>  ?;  # How to compare versions
    fhir:name @<string>?;                   # Name for this evidence variable 
                                            # (computer friendly) 
    fhir:title @<string>?;                  # Name for this evidence variable 
                                            # (human friendly) 
    fhir:shortTitle @<string>?;             # Title for use in informal contexts
    fhir:citeAs @<markdown>?;               # Display of how to cite this 
                                            # EvidenceVariable 

    fhir:status @<code> AND
    	{fhir:v @fhirvs:publication-status};  # draft | active | retired | unknown
    fhir:experimental @<boolean>?;          # For testing purposes, not real 

    fhir:experimental @<boolean>?;          # For testing only - never for real 

                                            # usage 
    fhir:date @<dateTime>?;                 # Date last changed
    fhir:author @<OneOrMore_ContactDetail>?;  # Who authored the content

    fhir:publisher @<string>?;              # Name of the publisher/steward 
                                            # (organization or individual) 
    fhir:contact @<OneOrMore_ContactDetail>?;  # Contact details for the publisher
    fhir:recorder @<OneOrMore_ContactDetail>?;  # Who entered the data for the 
                                            # evidence variable 
    fhir:editor @<OneOrMore_ContactDetail>?;  # Who edited the content
    fhir:reviewer @<OneOrMore_ContactDetail>?;  # Who reviewed the content
    fhir:endorser @<OneOrMore_ContactDetail>?;  # Who endorsed the content

    fhir:description @<markdown>?;          # Natural language description of 
                                            # the evidence variable 
    fhir:note @<OneOrMore_Annotation>?;     # Used for footnotes or explanatory 
                                            # notes 
    fhir:useContext @<OneOrMore_UsageContext>?;  # The context that the content is 
                                            # intended to support 
    fhir:purpose @<markdown>?;              # Why this EvidenceVariable is 
                                            # defined 
    fhir:copyright @<markdown>?;            # Use and/or publishing restrictions

    fhir:copyright @<markdown>?;            # Intellectual property ownership, 
                                            # may include restrictions on use 

    fhir:copyrightLabel @<string>?;         # Copyright holder and year(s)
    fhir:approvalDate @<date>?;             # When the resource was approved by 
                                            # publisher 
    fhir:lastReviewDate @<date>?;           # When the resource was last 
                                            # reviewed by the publisher 
    fhir:effectivePeriod @<Period>?;        # When the resource is expected to 
                                            # be used 
    fhir:author @<OneOrMore_ContactDetail>?;  # Who authored the content
    fhir:editor @<OneOrMore_ContactDetail>?;  # Who edited the content
    fhir:reviewer @<OneOrMore_ContactDetail>?;  # Who reviewed the content
    fhir:endorser @<OneOrMore_ContactDetail>?;  # Who endorsed the content
    fhir:relatedArtifact @<OneOrMore_RelatedArtifact>?;  # Additional documentation, 
                                            # citations, etc 

    fhir:relatesTo @<OneOrMore_EvidenceVariable.relatesTo>?;  # Relationships to other Resources

    fhir:actual @<boolean>?;                # Actual or conceptual
    fhir:characteristic @<OneOrMore_EvidenceVariable.characteristic>?;  # A defining factor of the 
                                            # EvidenceVariable 

    fhir:definition @<CodeableReference>?;  # The meaning of the evidence 
                                            # variable 
    fhir:definitionModifier @<OneOrMore_EvidenceVariable.definitionModifier>?;  # Further specification of the 
                                            # definition 

    fhir:handling @<code> AND
    	{fhir:v @fhirvs:variable-handling}?;  # continuous | dichotomous | ordinal 
                                            # | polychotomous 
    fhir:category @<OneOrMore_EvidenceVariable.category>?;  # A grouping for ordinal or 
                                            # polychotomous variables 

    	{fhir:v @fhirvs:variable-handling}?;  # boolean | continuous | dichotomous 
                                            # | ordinal | polychotomous | 
                                            # extension 
    fhir:category @<OneOrMore_EvidenceVariable.category>?;  # A grouping for dichotomous, 
                                            # ordinal, or polychotomouos 
                                            # variables 
    fhir:conditional @<Expression>?;        # Condition determining whether the 
                                            # data will be collected 
    fhir:classifier @<OneOrMore_CodeableConcept>?;  # Classification
    fhir:dataStorage @<OneOrMore_EvidenceVariable.dataStorage>?;  # How the data element (value of the 
                                            # variable) is found 
    fhir:timing @<RelativeTime>?;           # When the variable is observed
    fhir:period @<Period>?;                 # Calendar-based timing when the 
                                            # variable is observed 
    fhir:constraint @<OneOrMore_EvidenceVariable.constraint>?;  # Limit on acceptability of data 
                                            # value 
    fhir:missingDataMeaning @<OneOrMore_CodeableConcept>?;  # How missing data can be interpreted
    fhir:unacceptableDataHandling @<OneOrMore_CodeableConcept>?;  # How erroneous data is processed

}  
# Used to specify how two or more characteristics are combined
<EvidenceVariable.characteristic.definitionByCombination> EXTENDS @<BackboneElement> CLOSED {   
    fhir:code @<code> AND
    	{fhir:v @fhirvs:characteristic-combination};  # all-of | any-of | at-least | 
                                            # at-most | statistical | net-effect 
                                            # | dataset 
    fhir:threshold @<positiveInt>?;         # Provides the value of "n" when 
                                            # "at-least" or "at-most" codes are 
                                            # used 
    fhir:characteristic @<OneOrMore_EvidenceVariable.characteristic>;  # A defining factor of the 
                                            # characteristic 

# Limit on acceptability of data value
<EvidenceVariable.constraint> EXTENDS @<BackboneElement> CLOSED {   
    fhir:conditional @<CodeableConcept>?;   # Condition determining whether this 
                                            # constraint applies 
    fhir:minimumQuantity @<Quantity>?;      # The lowest permissible value of 
                                            # the variable 
    fhir:maximumQuantity @<Quantity>?;      # The highest permissible value of 
                                            # the variable 
    fhir:earliestDateTime @<dateTime>?;     # The earliest permissible value of 
                                            # the variable 
    fhir:latestDateTime @<dateTime>?;       # The latest permissible value of 
                                            # the variable 
    fhir:minimumStringLength @<unsignedInt>?;  # The lowest number of characters 
                                            # allowed for a value of the 
                                            # variable 
    fhir:maximumStringLength @<positiveInt>?;  # The highest number of characters 
                                            # allowed for a value of the 
                                            # variable 
    fhir:code @<CodeableConcept>?;          # Rule for acceptable data values
    fhir:expression @<Expression>?;         # Rule for acceptable data values, 
                                            # as an Expression 
    fhir:expectedValueSet @<Reference> AND {fhir:link 
    			@<ValueSet> ? }?;  # List of anticipated values used to 
                                            # express value of the variable 
    fhir:expectedUnitsValueSet @<Reference> AND {fhir:link 
    			@<ValueSet> ? }?;  # List of anticipated values used to 
                                            # express units for the value of the 
                                            # variable 
    fhir:anyValueAllowed @<boolean>?;       # Permissibility of unanticipated 
                                            # value used to express value of the 
                                            # variable 

}  
# Defines the characteristic using type and value
<EvidenceVariable.characteristic.definitionByTypeAndValue> EXTENDS @<BackboneElement> CLOSED {   
    fhir:type @<CodeableConcept>;           # Expresses the type of 
                                            # characteristic 
    fhir:method @<OneOrMore_CodeableConcept>?;  # Method for how the characteristic 
                                            # value was determined 
    fhir:device @<Reference> AND {fhir:link 
    			@<Device> OR 
    			@<DeviceMetric> ? }?;  # Device used for determining 
                                            # characteristic 

# Further specification of the definition
<EvidenceVariable.definitionModifier> EXTENDS @<BackboneElement> CLOSED {   
    fhir:code @<CodeableConcept>;           # Attribute of the definition

    fhir:value @<CodeableConcept>  OR 
    			@<boolean>  OR 
    			@<Quantity>  OR 
    			@<Range>  OR 
    			@<Reference>  OR 
    			@<id>  ;  # Defines the characteristic when 
                                            # coupled with characteristic.type 
    fhir:offset @<CodeableConcept>?;        # Reference point for valueQuantity 
                                            # or valueRange 

    			@<Period>  OR 
    			@<RelativeTime>  OR 
    			(@<Reference>  AND {fhir:link @<Resource> })  OR 
    			@<Expression>  OR 
    			@<uri>  ;  # Specification of the definition 
                                            # attribute 

}  
# A grouping for ordinal or polychotomous variables

 
<EvidenceVariable.dataStorage.componentnull> CLOSED {   
}  
# A grouping for dichotomous, ordinal, or polychotomouos variables

<EvidenceVariable.category> EXTENDS @<BackboneElement> CLOSED {   
    fhir:name @<string>?;                   # Description of the grouping
    fhir:value @<CodeableConcept>  OR 
    			@<Quantity>  OR 
    			@<Range>  ?;  # Definition of the grouping

    			@<Range>  OR 
    			(@<Reference>  AND {fhir:link @<Group> })  ?;  # Definition of the grouping

}  
# A defining factor of the EvidenceVariable
<EvidenceVariable.characteristic> EXTENDS @<BackboneElement> CLOSED {   
    fhir:linkId @<id>?;                     # Label for internal linking
    fhir:description @<markdown>?;          # Natural language description of 
                                            # the characteristic 
    fhir:note @<OneOrMore_Annotation>?;     # Used for footnotes or explanatory 
                                            # notes 
    fhir:exclude @<boolean>?;               # Whether the characteristic is an 
                                            # inclusion criterion or exclusion 
                                            # criterion 
    fhir:definitionReference @<Reference> AND {fhir:link 
    			@<Evidence> OR 
    			@<EvidenceVariable> OR 
    			@<Group> ? }?;  # Defines the characteristic 
                                            # (without using type and value) by 
                                            # a Reference 
    fhir:definitionCanonical @<canonical>?;  # Defines the characteristic 
                                            # (without using type and value) by 
                                            # a Canonical 
    fhir:definitionCodeableConcept @<CodeableConcept>?;  # Defines the characteristic 
                                            # (without using type and value) by 
                                            # a CodeableConcept 
    fhir:definitionExpression @<Expression>?;  # Defines the characteristic 
                                            # (without using type and value) by 
                                            # an expression 
    fhir:definitionId @<id>?;               # Defines the characteristic 
                                            # (without using type and value) by 
                                            # an id 
    fhir:definitionByTypeAndValue @<EvidenceVariable.characteristic.definitionByTypeAndValue>?;  # Defines the characteristic using 
                                            # type and value 
    fhir:definitionByCombination @<EvidenceVariable.characteristic.definitionByCombination>?;  # Used to specify how two or more 
                                            # characteristics are combined 
    fhir:instances @<Quantity>  OR 
    			@<Range>  ?;  # Number of occurrences meeting the 
                                            # characteristic 
    fhir:duration @<Quantity>  OR 
    			@<Range>  ?;  # Length of time in which the 
                                            # characteristic is met 
    fhir:timeFromEvent @<OneOrMore_EvidenceVariable.characteristic.timeFromEvent>?;  # Timing in which the characteristic 
                                            # is determined 

# How the data element (value of the variable) is found
<EvidenceVariable.dataStorage> EXTENDS @<BackboneElement> CLOSED {   
    fhir:datatype @<CodeableConcept>?;      # Type of data used to express value 
                                            # of the variable 
    fhir:path @<string>?;                   # Where to find the data element in 
                                            # the dataset 
    fhir:delimiter @<string>?;              # Character(s) separating values in 
                                            # a string-based list 
    fhir:component @<OneOrMore_EvidenceVariable.dataStorage>?; 

}  
# Timing in which the characteristic is determined
<EvidenceVariable.characteristic.timeFromEvent> EXTENDS @<BackboneElement> CLOSED {   
    fhir:description @<markdown>?;          # Human readable description
    fhir:note @<OneOrMore_Annotation>?;     # Used for footnotes or explanatory 
                                            # notes 
    fhir:event @<CodeableConcept>  OR 
    			@<Reference>  OR 
    			@<dateTime>  OR 
    			@<id>  ?;  # The event used as a base point 
                                            # (reference point) in time 
    fhir:quantity @<Quantity>?;             # Used to express the observation at 
                                            # a defined amount of time before or 
                                            # after the event 
    fhir:range @<Range>?;                   # Used to express the observation 
                                            # within a period before and/or 
                                            # after the event 

# Relationships to other Resources
<EvidenceVariable.relatesTo> EXTENDS @<BackboneElement> CLOSED {   
    fhir:type @<code> AND
    	{fhir:v @fhirvs:artifact-relationship-type};  # documentation | justification | 
                                            # predecessor | successor | 
                                            # derived-from | depends-on | 
                                            # composed-of | part-of | amends | 
                                            # amended-with | appends | 
                                            # appended-with | cites | cited-by | 
                                            # comments-on | comment-in | 
                                            # contains | contained-in | corrects 
                                            # | correction-in | replaces | 
                                            # replaced-with | retracts | 
                                            # retracted-by | signs | similar-to 
                                            # | supports | supported-with | 
                                            # transforms | transformed-into | 
                                            # transformed-with | 
                                            # specification-of | created-with | 
                                            # cite-as | summarizes 
    fhir:target @<uri>  OR 
    			@<Attachment>  OR 
    			(@<canonical>  AND {fhir:link @<Resource> })  OR 
    			(@<Reference>  AND {fhir:link @<Resource> })  OR 
    			@<markdown>  ;  # The artifact that is related to 
                                            # this EvidenceVariable 

}  
#---------------------- Cardinality Types (OneOrMore) -------------------
<OneOrMore_Identifier> CLOSED {
    rdf:first @<Identifier>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Identifier> 
}
<OneOrMore_ContactDetail> CLOSED {
    rdf:first @<ContactDetail>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_ContactDetail> 
}
<OneOrMore_Annotation> CLOSED {
    rdf:first @<Annotation>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Annotation> 
}
<OneOrMore_UsageContext> CLOSED {
    rdf:first @<UsageContext>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_UsageContext> 
}
<OneOrMore_RelatedArtifact> CLOSED {
    rdf:first @<RelatedArtifact>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_RelatedArtifact> 

<OneOrMore_EvidenceVariable.relatesTo> CLOSED {
    rdf:first @<EvidenceVariable.relatesTo>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_EvidenceVariable.relatesTo> 

}
<OneOrMore_EvidenceVariable.characteristic> CLOSED {
    rdf:first @<EvidenceVariable.characteristic>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_EvidenceVariable.characteristic> 

<OneOrMore_EvidenceVariable.definitionModifier> CLOSED {
    rdf:first @<EvidenceVariable.definitionModifier>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_EvidenceVariable.definitionModifier> 

}
<OneOrMore_EvidenceVariable.category> CLOSED {
    rdf:first @<EvidenceVariable.category>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_EvidenceVariable.category> 
}
<OneOrMore_CodeableConcept> CLOSED {
    rdf:first @<CodeableConcept>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_CodeableConcept> 
}
<OneOrMore_EvidenceVariable.characteristic.timeFromEvent> CLOSED {
    rdf:first @<EvidenceVariable.characteristic.timeFromEvent>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_EvidenceVariable.characteristic.timeFromEvent> 

<OneOrMore_EvidenceVariable.dataStorage> CLOSED {
    rdf:first @<EvidenceVariable.dataStorage>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_EvidenceVariable.dataStorage> 
}
<OneOrMore_EvidenceVariable.constraint> CLOSED {
    rdf:first @<EvidenceVariable.constraint>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_EvidenceVariable.constraint> 

}
#---------------------- Value Sets ------------------------
# Logical grouping of characteristics.
fhirvs:characteristic-combination ["all-of" "any-of" "at-least" "at-most" "statistical" "net-effect" "dataset"]

# Type of relationship to the related artifact.
fhirvs:artifact-relationship-type ["documentation" "justification" "predecessor" "successor" "derived-from" "depends-on" "composed-of" "part-of" "amends" "amended-with" "appends" "appended-with" "cites" "cited-by" "comments-on" "comment-in" "contains" "contained-in" "corrects" "correction-in" "replaces" "replaced-with" "retracts" "retracted-by" "signs" "similar-to" "supports" "supported-with" "transforms" "transformed-into" "transformed-with" "specification-of" "created-with" "cite-as" "summarizes"]

# The lifecycle status of an artifact.
fhirvs:publication-status ["draft" "active" "retired" "unknown"]
# The handling of the variable in statistical analysis for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive).
fhirvs:variable-handling ["continuous" "dichotomous" "ordinal" "polychotomous"]

fhirvs:variable-handling ["boolean" "continuous" "dichotomous" "ordinal" "polychotomous" "extension"]