Codesystem.shex

ShEx statement for codesystem

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


# A set of codes drawn from one or more code systems
<CodeSystem> CLOSED {
    a [fhir:CodeSystem];
    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:CodeSystem.url @<uri>?;            # Globally unique logical identifier 
                                            # for  code system (Coding.system) 
    fhir:CodeSystem.identifier @<Identifier>?;  # Additional identifier for the code 
                                            # system (e.g. HL7 v2 / CDA) 
    fhir:CodeSystem.version @<string>?;     # Logical identifier for this 
                                            # version (Coding.version) 
    fhir:CodeSystem.name @<string>?;        # Informal name for this code system
    fhir:CodeSystem.status @<code> AND
    	{fhir:value @fhirvs:conformance-resource-status};  # draft | active | retired
    fhir:CodeSystem.experimental @<boolean>?;  # If for testing purposes, not real 
                                            # usage 
    fhir:CodeSystem.publisher @<string>?;   # Name of the publisher 
                                            # (organization or individual) 
    fhir:CodeSystem.contact @<CodeSystem.contact>*;  # Contact details of the publisher
    fhir:CodeSystem.date @<dateTime>?;      # Date for given status
    fhir:CodeSystem.description @<markdown>?;  # Human language description of the 
                                            # code system 
    fhir:CodeSystem.useContext @<CodeableConcept>*;  # Content intends to support these 
                                            # contexts 
    fhir:CodeSystem.requirements @<markdown>?;  # Why needed
    fhir:CodeSystem.copyright @<string>?;   # Use and/or publishing restrictions
    fhir:CodeSystem.caseSensitive @<boolean>?;  # If code comparison is case 
                                            # sensitive 
    fhir:CodeSystem.valueSet @<uri>?;       # Canonical URL for value set with 
                                            # entire code system 
    fhir:CodeSystem.hierarchyMeaning @<code> AND
    	{fhir:value @fhirvs:codesystem-hierarchy-meaning}?;  # grouped-by | subsumes | part-of | 
                                            # classified-with 
    fhir:CodeSystem.compositional @<boolean>?;  # If code system defines a 
                                            # post-composition grammar 
    fhir:CodeSystem.versionNeeded @<boolean>?;  # If definitions are not stable
    fhir:CodeSystem.content @<code> AND
    	{fhir:value @fhirvs:codesystem-content-mode};  # not-present | examplar | fragment 
                                            # | complete 
    fhir:CodeSystem.count @<unsignedInt>?;  # Total concepts in the code system
    fhir:CodeSystem.filter @<CodeSystem.filter>*;  # Filter that can be used in a value 
                                            # set 
    fhir:CodeSystem.property @<CodeSystem.property>*;  # Additional information supplied 
                                            # about each concept 
    fhir:CodeSystem.concept @<CodeSystem.concept>*;  # Concepts in the code system
    fhir:index xsd:integer?                 # Relative position in a list
}

# Additional information supplied about each concept
<CodeSystem.property> 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:CodeSystem.property.code @<code>;  # Identifies the property on the 
                                            # concepts, and when referred to in 
                                            # operations 
    fhir:CodeSystem.property.uri @<uri>?;   # Formal identifier for the property
    fhir:CodeSystem.property.description @<string>?;  # Why the property is defined, 
                                            # and/or what it conveys 
    fhir:CodeSystem.property.type @<code> AND
    	{fhir:value @fhirvs:concept-property-type};  # code | Coding | string | integer | 
                                            # boolean | dateTime 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Concepts in the code system
<CodeSystem.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:CodeSystem.concept.code @<code>;   # Code that identifies concept
    fhir:CodeSystem.concept.display @<string>?;  # Text to display to the user
    fhir:CodeSystem.concept.definition @<string>?;  # Formal definition
    fhir:CodeSystem.concept.designation @<CodeSystem.concept.designation>*;  # Additional representations for the 
                                            # concept 
    fhir:CodeSystem.concept.property @<CodeSystem.concept.property>*;  # Property value for the concept
    fhir:CodeSystem.concept.concept @<CodeSystem.concept>*;  # Child Concepts 
                                            # (is-a/contains/categorizes) 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Filter that can be used in a value set
<CodeSystem.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:CodeSystem.filter.code @<code>;    # Code that identifies the filter
    fhir:CodeSystem.filter.description @<string>?;  # How or why the filter is used
    fhir:CodeSystem.filter.operator @<code> AND
    	{fhir:value @fhirvs:filter-operator}+;  # Operators that can be used with 
                                            # filter 
    fhir:CodeSystem.filter.value @<string>;  # What to use for the value
    fhir:index xsd:integer?                 # Relative position in a list
}

# Contact details of the publisher
<CodeSystem.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:CodeSystem.contact.name @<string>?;  # Name of an individual to contact
    fhir:CodeSystem.contact.telecom @<ContactPoint>*;  # Contact details for individual or 
                                            # publisher 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Property value for the concept
<CodeSystem.concept.property> 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:CodeSystem.concept.property.code @<code>;  # Reference to 
                                            # CodeSystem.property.code 
    (                                       # Value of the property for this 
                                            # concept 
        fhir:CodeSystem.concept.property.valueCode @<code>  |
        fhir:CodeSystem.concept.property.valueCoding @<Coding>  |
        fhir:CodeSystem.concept.property.valueString @<string>  |
        fhir:CodeSystem.concept.property.valueInteger @<integer>  |
        fhir:CodeSystem.concept.property.valueBoolean @<boolean>  |
        fhir:CodeSystem.concept.property.valueDateTime @<dateTime> 
    );
    fhir:index xsd:integer?                 # Relative position in a list
}

# Additional representations for the concept
<CodeSystem.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:CodeSystem.concept.designation.language @<code>?;  # Human language of the designation
    fhir:CodeSystem.concept.designation.use @<Coding>?;  # Details how this designation would 
                                            # be used 
    fhir:CodeSystem.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
}

# 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 unsignedInt
<unsignedInt> CLOSED {
    fhir: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 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
}

# 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"]

# The type of a property value
@fhirvs:concept-property-type = ["code" "Coding" "string" "integer" "boolean" "dateTime"]

# How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource
@fhirvs:codesystem-content-mode = ["not-present" "examplar" "fragment" "complete"]

# 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"]

# The meaning of the hierarchy of concepts in a code system
@fhirvs:codesystem-hierarchy-meaning = ["grouped-by" "subsumes" "part-of" "classified-with"]

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