Group.shex

ShEx statement for group

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 <Uri.shex>
IMPORT <Code.shex>

IMPORT <Range.shex>
IMPORT <string.shex>

IMPORT <String.shex>
IMPORT <Coding.shex>

IMPORT <Device.shex>
IMPORT <Period.shex>
IMPORT <boolean.shex>

IMPORT <Boolean.shex>

IMPORT <Patient.shex>
IMPORT <markdown.shex>

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

IMPORT <CareTeam.shex>
IMPORT <Location.shex>
IMPORT <Specimen.shex>
IMPORT <Quantity.shex>
IMPORT <Duration.shex>

IMPORT <Reference.shex>
IMPORT <Substance.shex>

IMPORT <Identifier.shex>
IMPORT <unsignedInt.shex>

IMPORT <Medication.shex>
IMPORT <Expression.shex>
IMPORT <UnsignedInt.shex>
IMPORT <PositiveInt.shex>
IMPORT <UsageContext.shex>

IMPORT <Organization.shex>
IMPORT <Practitioner.shex>
IMPORT <RelativeTime.shex>
IMPORT <ContactDetail.shex>

IMPORT <RelatedPerson.shex>
IMPORT <DomainResource.shex>
IMPORT <CodeableConcept.shex>
IMPORT <BackboneElement.shex>
IMPORT <PractitionerRole.shex>
IMPORT <NutritionProduct.shex>
IMPORT <DeviceDefinition.shex>

IMPORT <HealthcareService.shex>
IMPORT <SubstanceDefinition.shex>
IMPORT <BiologicallyDerivedProduct.shex>
IMPORT <MedicinalProductDefinition.shex>

start=@<Group> AND {fhir:nodeRole [fhir:treeRoot]}
# Group of multiple entities
<Group> EXTENDS @<DomainResource> CLOSED {   
    a [fhir:Group]?;fhir:nodeRole [fhir:treeRoot]?;

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

    fhir:url @<Uri>?;                       # Canonical identifier for this 
                                            # Group, represented as an absolute 
                                            # URI (globally unique) 

    fhir:identifier @<OneOrMore_Identifier>?;  # Business Identifier for this Group
    fhir:active @<boolean>?;                # Whether this group's record is in 
                                            # active use 
    fhir:type @<code> AND
    	{fhir:v @fhirvs:group-type};  # person | animal | practitioner | 

    fhir:version @<String>?;                # Business version of the Group
    fhir:versionAlgorithm @<String>  OR 
    			@<Coding>  ?;  # How to compare versions
    fhir:name @<String>?;                   # Label for Group
    fhir:title @<String>?;                  # Name for this Group (human 
                                            # friendly) 
    fhir:status @<Code> AND
    	{fhir:v @fhirvs:publication-status}?;  # draft | active | retired | unknown
    fhir:experimental @<Boolean>?;          # For testing only - never for real 
                                            # usage 
    fhir:date @<DateTime>?;                 # Date last changed
    fhir:publisher @<String>?;              # Name of the publisher/steward 
                                            # (organization or individual) 
    fhir:contact @<OneOrMore_ContactDetail>?;  # Contact details for the publisher
    fhir:description @<Markdown>?;          # Natural language description of 
                                            # the group 
    fhir:useContext @<OneOrMore_UsageContext>?;  # The context that the content is 
                                            # intended to support 
    fhir:purpose @<Markdown>?;              # Why this Group is defined
    fhir:copyright @<Markdown>?;            # Notice about intellectual property 
                                            # ownership, can include 
                                            # restrictions on use 
    fhir:copyrightLabel @<String>?;         # Copyright holder and year(s)
    fhir:type @<Code> AND
    	{fhir:v @fhirvs:group-type}?;  # person | animal | practitioner | 

                                            # device | careteam | 
                                            # healthcareservice | location | 
                                            # organization | relatedperson | 
                                            # specimen 
    fhir:membership @<code> AND
    	{fhir:v @fhirvs:group-membership-basis};  # definitional | enumerated
    fhir:code @<CodeableConcept>?;          # Kind of Group members
    fhir:name @<string>?;                   # Label for Group
    fhir:description @<markdown>?;          # Natural language description of 
                                            # the group 
    fhir:quantity @<unsignedInt>?;          # Number of members
    fhir:managingEntity @<Reference> AND {fhir:link 

                                            # specimen | medication | 
                                            # medicinalproductdefinition | 
                                            # substance | substancedefinition | 
                                            # biologicallyDerivedProduct | 
                                            # nutritionProduct 
    fhir:membership @<Code> AND
    	{fhir:v @fhirvs:group-membership-basis};  # definitional | conceptual | 
                                            # enumerated 
    fhir:code @<CodeableConcept>?;          # Use of the Group (and by 
                                            # implication, kind of members) 
    fhir:quantity @<UnsignedInt>?;          # Number of members
    fhir:managingEntity @<Reference> AND {fhir:l 

    			@<Organization> OR 
    			@<Practitioner> OR 
    			@<PractitionerRole> OR 
    			@<RelatedPerson> ? }?;  # Entity that is the custodian of 
                                            # the Group's definition 
    fhir:combinationMethod @<Code> AND
    	{fhir:v @fhirvs:group-characteristic-combination}?;  # all-of | any-of | at-least | 
                                            # at-most | except-subset 
    fhir:combinationThreshold @<PositiveInt>?;  # Provides the value of "n" when 
                                            # "at-least" or "at-most" codes are 
                                            # used 

    fhir:characteristic @<OneOrMore_Group.characteristic>?;  # Include / Exclude group members by 
                                            # Trait 
    fhir:member @<OneOrMore_Group.member>?;  # Who or what is in group
}  
# Who or what is in group
<Group.member> EXTENDS @<BackboneElement> CLOSED {   
    fhir:entity @<Reference> AND {fhir:link 

    fhir:entity @<Reference> AND {fhir:l 
    			@<BiologicallyDerivedProduct> OR 

    			@<CareTeam> OR 
    			@<Device> OR 
    			@<Group> OR 
    			@<HealthcareService> OR 
    			@<Location> OR 
    			@<Medication> OR 
    			@<MedicinalProductDefinition> OR 
    			@<NutritionProduct> OR 

    			@<Organization> OR 
    			@<Patient> OR 
    			@<Practitioner> OR 
    			@<PractitionerRole> OR 
    			@<RelatedPerson> OR 
    			@<Specimen> ? };  # Reference to the group member

    			@<Specimen> OR 
    			@<Substance> OR 
    			@<SubstanceDefinition> ? };  # Reference to the group member
    fhir:involvement @<OneOrMore_CodeableConcept>?;  # Code that describes how user is 
                                            # part of the group 

    fhir:period @<Period>?;                 # Period member belonged to the group
    fhir:inactive @<boolean>?;              # If member is no longer in group

    fhir:inactive @<Boolean>?;              # If member is no longer in group

}  
# Include / Exclude group members by Trait
<Group.characteristic> EXTENDS @<BackboneElement> CLOSED {   
    fhir:code @<CodeableConcept>;           # Kind of characteristic
    fhir:value @<CodeableConcept>  OR 
    			@<boolean>  OR 

    			@<Boolean>  OR 

    			@<Quantity>  OR 
    			@<Range>  OR 
    			@<Reference>  ;  # Value held by characteristic
    fhir:exclude @<boolean>;                # Group includes or excludes

    			@<Reference>  OR 
    			@<Uri>  OR 
    			@<Expression>  ;  # Value held by characteristic
    fhir:exclude @<Boolean>;                # Group includes or excludes
    fhir:description @<Markdown>?;          # Natural language description of 
                                            # the characteristic 
    fhir:method @<OneOrMore_CodeableConcept>?;  # Method for how the characteristic 
                                            # value was determined 
    fhir:formula @<Expression>?;            # Formal algorithm to derive the 
                                            # value 
    fhir:determiner @<Reference> AND {fhir:l 
    			@<Device> OR 
    			@<DeviceDefinition> OR 
    			@<Organization> OR 
    			@<Practitioner> OR 
    			@<PractitionerRole> ? }?;  # Who determines the value
    fhir:offset @<CodeableConcept>?;        # Reference point for comparison
    fhir:instances @<UnsignedInt>  OR 
    			@<Range>  ?;  # Number of occurrences meeting the 
                                            # characteristic 
    fhir:duration @<Duration>  OR 
    			@<Range>  ?;  # Length of time in which the 
                                            # characteristic is met 

    fhir:period @<Period>?;                 # Period over which characteristic 
                                            # is tested 
    fhir:timing @<OneOrMore_RelativeTime>?;  # Timing in which the characteristic 
                                            # is determined 

}  
#---------------------- 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_UsageContext> CLOSED {
    rdf:first @<UsageContext>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_UsageContext> 
}

<OneOrMore_Group.characteristic> CLOSED {
    rdf:first @<Group.characteristic>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Group.characteristic> 
}
<OneOrMore_Group.member> CLOSED {
    rdf:first @<Group.member>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Group.member> 
}
<OneOrMore_CodeableConcept> CLOSED {
    rdf:first @<CodeableConcept>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_CodeableConcept> 
}
<OneOrMore_RelativeTime> CLOSED {
    rdf:first @<RelativeTime>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_RelativeTime> 
}

#---------------------- Value Sets ------------------------
# Logical grouping of characteristics for the Group Resource.
fhirvs:group-characteristic-combination ["all-of" "any-of" "at-least" "at-most" "except-subset"]

# Basis for membership in a group
fhirvs:group-membership-basis ["definitional" "enumerated"]

fhirvs:group-membership-basis ["definitional" "conceptual" "enumerated"]

# Types of resources that are part of group.
fhirvs:group-type ["person" "animal" "practitioner" "device" "careteam" "healthcareservice" "location" "organization" "relatedperson" "specimen"]

fhirvs:group-type ["person" "animal" "practitioner" "device" "careteam" "healthcareservice" "location" "organization" "relatedperson" "specimen" "medication" "medicinalproductdefinition" "substance" "substancedefinition" "biologicallyDerivedProduct" "nutritionProduct"]
# The lifecycle status of an artifact.
fhirvs:publication-status ["draft" "active" "retired" "unknown"]