Valueset.shex

ShEx statement for valueset

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=<ValueSet> AND {fhir:nodeRole [fhir:treeRoot]}


# A set of codes drawn from one or more code systems
<ValueSet> CLOSED {
    a [fhir:ValueSet];
    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:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.url @<uri>?;              # Globally unique logical identifier 
                                            # for  value set 
    fhir:ValueSet.identifier @<Identifier>*;  # Additional identifier for the 
                                            # value set (e.g. HL7 v2 / CDA) 
    fhir:ValueSet.version @<string>?;       # Logical identifier for this 
                                            # version of the value set 
    fhir:ValueSet.name @<string>?;          # Informal name for this value set
    fhir:ValueSet.status @<code> AND
    	{fhir:value @fhirvs:conformance-resource-status};  # draft | active | retired
    fhir:ValueSet.experimental @<boolean>?;  # If for testing purposes, not real 
                                            # usage 
    fhir:ValueSet.publisher @<string>?;     # Name of the publisher 
                                            # (organization or individual) 
    fhir:ValueSet.contact @<ValueSet.contact>*;  # Contact details of the publisher
    fhir:ValueSet.date @<dateTime>?;        # Date for given status
    fhir:ValueSet.lockedDate @<date>?;      # Fixed date for all referenced code 
                                            # systems and value sets 
    fhir:ValueSet.description @<markdown>?;  # Human language description of the 
                                            # value set 
    fhir:ValueSet.useContext @<CodeableConcept>*;  # Content intends to support these 
                                            # contexts 
    fhir:ValueSet.immutable @<boolean>?;    # Indicates whether or not any 
                                            # change to the content logical 
                                            # definition may occur 
    fhir:ValueSet.requirements @<markdown>?;  # Why needed
    fhir:ValueSet.copyright @<string>?;     # Use and/or publishing restrictions
    fhir:ValueSet.extensible @<boolean>?;   # Whether this is intended to be 
                                            # used with an extensible binding 
    fhir:ValueSet.compose @<ValueSet.compose>?;  # When value set includes codes from 
                                            # elsewhere 
    fhir:ValueSet.expansion @<ValueSet.expansion>?;  # Used when the value set is 
                                            # "expanded" 
    fhir:index xsd:integer?                 # Relative position in a list
}

# When value set includes codes from elsewhere
<ValueSet.compose> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.compose.import @<uri>*;   # Import the contents of another 
                                            # value set 
    fhir:ValueSet.compose.include @<ValueSet.compose.include>*;  # Include one or more codes from a 
                                            # code system 
    fhir:ValueSet.compose.exclude @<ValueSet.compose.include>*;  # Explicitly exclude codes
    fhir:index xsd:integer?                 # Relative position in a list
}

# Used when the value set is "expanded"
<ValueSet.expansion> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.expansion.identifier @<uri>;  # Uniquely identifies this expansion
    fhir:ValueSet.expansion.timestamp @<dateTime>;  # Time ValueSet expansion happened
    fhir:ValueSet.expansion.total @<integer>?;  # Total number of codes in the 
                                            # expansion 
    fhir:ValueSet.expansion.offset @<integer>?;  # Offset at which this resource 
                                            # starts 
    fhir:ValueSet.expansion.parameter @<ValueSet.expansion.parameter>*;  # Parameter that controlled the 
                                            # expansion process 
    fhir:ValueSet.expansion.contains @<ValueSet.expansion.contains>*;  # Codes in the value set
    fhir:index xsd:integer?                 # Relative position in a list
}

# Contact details of the publisher
<ValueSet.contact> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.contact.name @<string>?;  # Name of an individual to contact
    fhir:ValueSet.contact.telecom @<ContactPoint>*;  # Contact details for individual or 
                                            # publisher 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Parameter that controlled the expansion process
<ValueSet.expansion.parameter> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.expansion.parameter.name @<string>;  # Name as assigned by the server
    (                                       # Value of the named parameter
        fhir:ValueSet.expansion.parameter.valueString @<string>  |
        fhir:ValueSet.expansion.parameter.valueBoolean @<boolean>  |
        fhir:ValueSet.expansion.parameter.valueInteger @<integer>  |
        fhir:ValueSet.expansion.parameter.valueDecimal @<decimal>  |
        fhir:ValueSet.expansion.parameter.valueUri @<uri>  |
        fhir:ValueSet.expansion.parameter.valueCode @<code> 
    )?;
    fhir:index xsd:integer?                 # Relative position in a list
}

# Codes in the value set
<ValueSet.expansion.contains> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.expansion.contains.system @<uri>?;  # System value for the code
    fhir:ValueSet.expansion.contains.abstract @<boolean>?;  # If user cannot select this entry
    fhir:ValueSet.expansion.contains.version @<string>?;  # Version in which this code/display 
                                            # is defined 
    fhir:ValueSet.expansion.contains.code @<code>?;  # Code - if blank, this is not a 
                                            # selectable code 
    fhir:ValueSet.expansion.contains.display @<string>?;  # User display for the concept
    fhir:ValueSet.expansion.contains.contains @<ValueSet.expansion.contains>*;  # Codes contained under this entry
    fhir:index xsd:integer?                 # Relative position in a list
}

# Include one or more codes from a code system
<ValueSet.compose.include> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.compose.include.system @<uri>;  # The system the codes come from
    fhir:ValueSet.compose.include.version @<string>?;  # Specific version of the code 
                                            # system referred to 
    fhir:ValueSet.compose.include.concept @<ValueSet.compose.include.concept>*;  # A concept defined in the system
    fhir:ValueSet.compose.include.filter @<ValueSet.compose.include.filter>*;  # Select codes/concepts by their 
                                            # properties (including 
                                            # relationships) 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Select codes/concepts by their properties (including relationships)
<ValueSet.compose.include.filter> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.compose.include.filter.property @<code>;  # A property defined by the code 
                                            # system 
    fhir:ValueSet.compose.include.filter.op @<code> AND
    	{fhir:value @fhirvs:filter-operator};  # = | is-a | is-not-a | regex | in | 
                                            # not-in | generalizes 
    fhir:ValueSet.compose.include.filter.value @<code>;  # Code from the system, or regex 
                                            # criteria 
    fhir:index xsd:integer?                 # Relative position in a list
}

# A concept defined in the system
<ValueSet.compose.include.concept> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.compose.include.concept.code @<code>;  # Code or expression from system
    fhir:ValueSet.compose.include.concept.display @<string>?;  # Text to display for this code for 
                                            # this value set 
    fhir:ValueSet.compose.include.concept.designation @<ValueSet.compose.include.concept.designation>*;  # Additional representations for 
                                            # this valueset 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Additional representations for this valueset
<ValueSet.compose.include.concept.designation> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ValueSet.compose.include.concept.designation.language @<code>?;  # Human language of the designation
    fhir:ValueSet.compose.include.concept.designation.use @<Coding>?;  # Details how this designation would 
                                            # be used 
    fhir:ValueSet.compose.include.concept.designation.value @<string>;  # The text value for this designation
    fhir:index xsd:integer?                 # Relative position in a list
}

#---------------------- Data Types -------------------

# Primitive Type dateTime
<dateTime> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir: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
}

# Primitive Type date
<date> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir: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
}

# Metadata about a resource
<Meta> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir: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: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:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir: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
}

# 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?
}

# Primitive Type integer
<integer> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:int MININCLUSIVE "-2147483648"^^xsd:int MAXINCLUSIVE "2147483647"^^xsd:int?;  # Primitive value for integer
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type uri
<uri> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:string?;                 # Primitive value for uri
    fhir:index xsd:integer?                 # Relative position in a list
}

<Extension> {fhir:extension @<Extension>*;
    fhir:index xsd:integer?
}

# Details of a Technology mediated contact point (phone, fax, email, etc.)
<ContactPoint> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:ContactPoint.system @<code> AND
    	{fhir:value @fhirvs:contact-point-system}?;  # phone | fax | email | pager | 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
}

# An identifier intended for computation
<Identifier> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir: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
    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 @<OrganizationReference>?;  # Organization that issued id (may 
                                            # be just text) 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type boolean
<boolean> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:boolean?;                # Primitive value for boolean
    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: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
}

# A reference to a code defined by a terminology system
<Coding> CLOSED {
    fhir:concept IRI?;
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir: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:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:string?;                 # Primitive value for markdown
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type id
<id> CLOSED {
    fhir: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:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir: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 {
    fhir:concept IRI*;
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir: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
}

# Time range defined by start and end date/time
<Period> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir: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 instant
<instant> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:dateTime?;               # Primitive value for instant
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type positiveInt
<positiveInt> CLOSED {
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:positiveInteger?;        # Primitive value for positiveInt
    fhir:index xsd:integer?                 # Relative position in a list
}

#---------------------- Reference Types -------------------

<OrganizationReference> CLOSED {
    fhir:Element.id @<id>?;
    fhir:extension @<Extension>*;
    fhir:link @<Organization> OR CLOSED {a fhir:Organization}?;
    fhir:Reference.reference @<string>?;
    fhir:Reference.display @<string>?;
    fhir:index xsd:integer?
}

#---------------------- Value Sets ------------------------

# The lifecycle status of a Value Set or Concept Map.
@fhirvs:conformance-resource-status = ["draft" "active" "retired"]

# Use of contact point
@fhirvs:contact-point-use = ["home" "work" "temp" "old" "mobile"]

# The kind of operation to perform as a part of a property based filter.
@fhirvs:filter-operator = ["=" "is-a" "is-not-a" "regex" "in" "not-in" "generalizes"]

# Telecommunications form for contact point
@fhirvs:contact-point-system = ["phone" "fax" "email" "pager" "other"]

# The status of a resource narrative
@fhirvs:narrative-status = ["generated" "extensions" "additional" "empty"]

# Identifies the purpose for this identifier, if known .
@fhirvs:identifier-use = ["usual" "official" "temp" "secondary"]