STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Conformance.shex

Raw ShEx

ShEx statement for conformance

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


# A conformance statement
<Conformance> CLOSED {
    a [fhir:Conformance];
    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:Conformance.url @<uri>?;           # Logical uri to reference this 
                                            # statement 
    fhir:Conformance.version @<string>?;    # Logical id for this version of the 
                                            # statement 
    fhir:Conformance.name @<string>?;       # Informal name for this conformance 
                                            # statement 
    fhir:Conformance.status @<code> AND
    	{fhir:value @fhirvs:conformance-resource-status};  # draft | active | retired
    fhir:Conformance.experimental @<boolean>?;  # If for testing purposes, not real 
                                            # usage 
    fhir:Conformance.date @<dateTime>;      # Publication Date(/time)
    fhir:Conformance.publisher @<string>?;  # Name of the publisher 
                                            # (Organization or individual) 
    fhir:Conformance.contact @<Conformance.contact>*;  # Contact details of the publisher
    fhir:Conformance.description @<markdown>?;  # Human description of the 
                                            # conformance statement 
    fhir:Conformance.useContext @<CodeableConcept>*;  # Content intends to support these 
                                            # contexts 
    fhir:Conformance.requirements @<markdown>?;  # Why this resource has been created
    fhir:Conformance.copyright @<string>?;  # Use and/or publishing restrictions
    fhir:Conformance.kind @<code> AND
    	{fhir:value @fhirvs:conformance-statement-kind};  # instance | capability | 
                                            # requirements 
    fhir:Conformance.instantiates @<uri>*;  # Canonical URL of service 
                                            # implemented/used by software 
    fhir:Conformance.software @<Conformance.software>?;  # Software that is covered by this 
                                            # conformance statement 
    fhir:Conformance.implementation @<Conformance.implementation>?;  # If this describes a specific 
                                            # instance 
    fhir:Conformance.fhirVersion @<id>;     # FHIR Version the system uses
    fhir:Conformance.acceptUnknown @<code> AND
    	{fhir:value @fhirvs:unknown-content-code};  # no | extensions | elements | both
    fhir:Conformance.format @<code>+;       # formats supported (xml | json | 
                                            # ttl | mime type) 
    fhir:Conformance.profile @<StructureDefinitionReference>*;  # Profiles for use cases supported
    fhir:Conformance.rest @<Conformance.rest>*;  # If the endpoint is a RESTful one
    fhir:Conformance.messaging @<Conformance.messaging>*;  # If messaging is supported
    fhir:Conformance.document @<Conformance.document>*;  # Document definition
    fhir:index xsd:integer?                 # Relative position in a list
}

# If this describes a specific instance
<Conformance.implementation> 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:Conformance.implementation.description @<string>;  # Describes this specific instance
    fhir:Conformance.implementation.url @<uri>?;  # Base URL for the installation
    fhir:index xsd:integer?                 # Relative position in a list
}

# If messaging is supported
<Conformance.messaging> 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:Conformance.messaging.endpoint @<Conformance.messaging.endpoint>*;  # Where messages should be sent
    fhir:Conformance.messaging.reliableCache @<unsignedInt>?;  # Reliable Message Cache Length (min)
    fhir:Conformance.messaging.documentation @<string>?;  # Messaging interface behavior 
                                            # details 
    fhir:Conformance.messaging.event @<Conformance.messaging.event>+;  # Declare support for this event
    fhir:index xsd:integer?                 # Relative position in a list
}

# Software that is covered by this conformance statement
<Conformance.software> 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:Conformance.software.name @<string>;  # A name the software is known by
    fhir:Conformance.software.version @<string>?;  # Version covered by this statement
    fhir:Conformance.software.releaseDate @<dateTime>?;  # Date this version released
    fhir:index xsd:integer?                 # Relative position in a list
}

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

# If the endpoint is a RESTful one
<Conformance.rest> 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:Conformance.rest.mode @<code> AND
    	{fhir:value @fhirvs:restful-conformance-mode};  # client | server
    fhir:Conformance.rest.documentation @<string>?;  # General description of 
                                            # implementation 
    fhir:Conformance.rest.security @<Conformance.rest.security>?;  # Information about security of 
                                            # implementation 
    fhir:Conformance.rest.resource @<Conformance.rest.resource>*;  # Resource served on the REST 
                                            # interface 
    fhir:Conformance.rest.interaction @<Conformance.rest.interaction>*;  # What operations are supported?
    fhir:Conformance.rest.searchParam @<Conformance.rest.resource.searchParam>*;  # Search params for searching all 
                                            # resources 
    fhir:Conformance.rest.operation @<Conformance.rest.operation>*;  # Definition of an operation or a 
                                            # custom query 
    fhir:Conformance.rest.compartment @<uri>*;  # Compartments served/used by system
    fhir:index xsd:integer?                 # Relative position in a list
}

# Document definition
<Conformance.document> 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:Conformance.document.mode @<code> AND
    	{fhir:value @fhirvs:document-mode};  # producer | consumer
    fhir:Conformance.document.documentation @<string>?;  # Description of document support
    fhir:Conformance.document.profile @<StructureDefinitionReference>;  # Constraint on a resource used in 
                                            # the document 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Declare support for this event
<Conformance.messaging.event> 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:Conformance.messaging.event.code @<Coding>;  # Event type
    fhir:Conformance.messaging.event.category @<code> AND
    	{fhir:value @fhirvs:message-significance-category}?;  # Consequence | Currency | 
                                            # Notification 
    fhir:Conformance.messaging.event.mode @<code> AND
    	{fhir:value @fhirvs:message-conformance-event-mode};  # sender | receiver
    fhir:Conformance.messaging.event.focus @<code> AND
    	{fhir:value @fhirvs:resource-types};  # Resource that's focus of message
    fhir:Conformance.messaging.event.request @<StructureDefinitionReference>;  # Profile that describes the request
    fhir:Conformance.messaging.event.response @<StructureDefinitionReference>;  # Profile that describes the response
    fhir:Conformance.messaging.event.documentation @<string>?;  # Endpoint-specific event 
                                            # documentation 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Information about security of implementation
<Conformance.rest.security> 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:Conformance.rest.security.cors @<boolean>?;  # Adds CORS Headers 
                                            # (http://enable-cors.org/) 
    fhir:Conformance.rest.security.service @<CodeableConcept>*;  # OAuth | SMART-on-FHIR | NTLM | 
                                            # Basic | Kerberos | Certificates 
    fhir:Conformance.rest.security.description @<string>?;  # General description of how 
                                            # security works 
    fhir:Conformance.rest.security.certificate @<Conformance.rest.security.certificate>*;  # Certificates associated with 
                                            # security profiles 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Resource served on the REST interface
<Conformance.rest.resource> 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:Conformance.rest.resource.type @<code> AND
    	{fhir:value @fhirvs:resource-types};  # A resource type that is supported
    fhir:Conformance.rest.resource.profile @<StructureDefinitionReference>?;  # Base System profile for all uses 
                                            # of resource 
    fhir:Conformance.rest.resource.documentation @<markdown>?;  # Additional information about the 
                                            # use of the resource type 
    fhir:Conformance.rest.resource.interaction @<Conformance.rest.resource.interaction>+;  # What operations are supported?
    fhir:Conformance.rest.resource.versioning @<code> AND
    	{fhir:value @fhirvs:versioning-policy}?;  # no-version | versioned | 
                                            # versioned-update 
    fhir:Conformance.rest.resource.readHistory @<boolean>?;  # Whether vRead can return past 
                                            # versions 
    fhir:Conformance.rest.resource.updateCreate @<boolean>?;  # If update can commit to a new 
                                            # identity 
    fhir:Conformance.rest.resource.conditionalCreate @<boolean>?;  # If allows/uses conditional create
    fhir:Conformance.rest.resource.conditionalRead @<code> AND
    	{fhir:value @fhirvs:conditional-read-status}?;  # not-supported | modified-since | 
                                            # not-match | full-support 
    fhir:Conformance.rest.resource.conditionalUpdate @<boolean>?;  # If allows/uses conditional update
    fhir:Conformance.rest.resource.conditionalDelete @<code> AND
    	{fhir:value @fhirvs:conditional-delete-status}?;  # not-supported | single | multiple 
                                            # - how conditional delete is 
                                            # supported 
    fhir:Conformance.rest.resource.searchInclude @<string>*;  # _include values supported by the 
                                            # server 
    fhir:Conformance.rest.resource.searchRevInclude @<string>*;  # _revinclude values supported by 
                                            # the server 
    fhir:Conformance.rest.resource.searchParam @<Conformance.rest.resource.searchParam>*;  # Search params supported by 
                                            # implementation 
    fhir:index xsd:integer?                 # Relative position in a list
}

# What operations are supported?
<Conformance.rest.interaction> 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:Conformance.rest.interaction.code @<code> AND
    	{fhir:value @fhirvs:system-restful-interaction};  # transaction | batch | 
                                            # search-system | history-system 
    fhir:Conformance.rest.interaction.documentation @<string>?;  # Anything special about operation 
                                            # behavior 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Where messages should be sent
<Conformance.messaging.endpoint> 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:Conformance.messaging.endpoint.protocol @<Coding>;  # http | ftp | mllp +
    fhir:Conformance.messaging.endpoint.address @<uri>;  # Address of end-point
    fhir:index xsd:integer?                 # Relative position in a list
}

# Definition of an operation or a custom query
<Conformance.rest.operation> 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:Conformance.rest.operation.name @<string>;  # Name by which the operation/query 
                                            # is invoked 
    fhir:Conformance.rest.operation.definition @<OperationDefinitionReference>;  # The defined operation/query
    fhir:index xsd:integer?                 # Relative position in a list
}

# Certificates associated with security profiles
<Conformance.rest.security.certificate> 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:Conformance.rest.security.certificate.type @<code>?;  # Mime type for certificate
    fhir:Conformance.rest.security.certificate.blob @<base64Binary>?;  # Actual certificate
    fhir:index xsd:integer?                 # Relative position in a list
}

# Search params supported by implementation
<Conformance.rest.resource.searchParam> 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:Conformance.rest.resource.searchParam.name @<string>;  # Name of search parameter
    fhir:Conformance.rest.resource.searchParam.definition @<uri>?;  # Source of definition for parameter
    fhir:Conformance.rest.resource.searchParam.type @<code> AND
    	{fhir:value @fhirvs:search-param-type};  # number | date | string | token | 
                                            # reference | composite | quantity | 
                                            # uri 
    fhir:Conformance.rest.resource.searchParam.documentation @<string>?;  # Server-specific usage
    fhir:Conformance.rest.resource.searchParam.target @<code> AND
    	{fhir:value @fhirvs:resource-types}*;  # Types of resource (if a resource 
                                            # reference) 
    fhir:Conformance.rest.resource.searchParam.modifier @<code> AND
    	{fhir:value @fhirvs:search-modifier-code}*;  # missing | exact | contains | not | 
                                            # text | in | not-in | below | above 
                                            # | type 
    fhir:Conformance.rest.resource.searchParam.chain @<string>*;  # Chained names supported
    fhir:index xsd:integer?                 # Relative position in a list
}

# What operations are supported?
<Conformance.rest.resource.interaction> 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:Conformance.rest.resource.interaction.code @<code> AND
    	{fhir:value @fhirvs:type-restful-interaction};  # read | vread | update | delete | 
                                            # history-instance | history-type | 
                                            # create | search-type 
    fhir:Conformance.rest.resource.interaction.documentation @<string>?;  # Anything special about operation 
                                            # behavior 
    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 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
}

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

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

<OperationDefinitionReference> CLOSED {
    fhir:Element.id @<id>?;
    fhir:extension @<Extension>*;
    fhir:link @<OperationDefinition> OR CLOSED {a fhir:OperationDefinition}?;
    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"]

# A code that indicates how the server supports conditional read.
@fhirvs:conditional-read-status = ["not-supported" "modified-since" "not-match" "full-support"]

# Whether the application produces or consumes documents.
@fhirvs:document-mode = ["producer" "consumer"]

# Operations supported by REST at the system level.
@fhirvs:system-restful-interaction = ["transaction" "batch" "search-system" "history-system"]

# Operations supported by REST at the type or instance level.
@fhirvs:type-restful-interaction = ["read" "vread" "update" "delete" "history-instance" "history-type" "create" "search-type"]

# The impact of the content of a message.
@fhirvs:message-significance-category = ["Consequence" "Currency" "Notification"]

# How the system supports versioning for a resource.
@fhirvs:versioning-policy = ["no-version" "versioned" "versioned-update"]

# The mode of a message conformance statement.
@fhirvs:message-conformance-event-mode = ["sender" "receiver"]

# A code that indicates how the server supports conditional delete.
@fhirvs:conditional-delete-status = ["not-supported" "single" "multiple"]

# Data types allowed to be used for search parameters.
@fhirvs:search-param-type = ["number" "date" "string" "token" "reference" "composite" "quantity" "uri"]

# A supported modifier for a search parameter.
@fhirvs:search-modifier-code = ["missing" "exact" "contains" "not" "text" "in" "not-in" "below" "above" "type"]

# The mode of a RESTful conformance statement.
@fhirvs:restful-conformance-mode = ["client" "server"]

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

# How a conformance statement is intended to be used.
@fhirvs:conformance-statement-kind = ["instance" "capability" "requirements"]

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

# A code that indicates whether an application accepts unknown elements or extensions when reading resources.
@fhirvs:unknown-content-code = ["no" "extensions" "elements" "both"]

# One of the resource types defined as part of FHIR.
@fhirvs:resource-types = ["Account" "ActivityDefinition" "AllergyIntolerance" "Appointment" "AppointmentResponse" "AuditEvent" "Basic" "Binary" "BodySite" "Bundle" "CarePlan" "CareTeam" "Claim" "ClaimResponse" "ClinicalImpression" "CodeSystem" "Communication" "CommunicationRequest" "CompartmentDefinition" "Composition" "ConceptMap" "Condition" "Conformance" "Consent" "Contract" "Coverage" "DataElement" "DecisionSupportServiceModule" "DetectedIssue" "Device" "DeviceComponent" "DeviceMetric" "DeviceUseRequest" "DeviceUseStatement" "DiagnosticReport" "DiagnosticRequest" "DocumentManifest" "DocumentReference" "DomainResource" "EligibilityRequest" "EligibilityResponse" "Encounter" "Endpoint" "EnrollmentRequest" "EnrollmentResponse" "EpisodeOfCare" "ExpansionProfile" "ExplanationOfBenefit" "FamilyMemberHistory" "Flag" "Goal" "Group" "GuidanceResponse" "HealthcareService" "ImagingManifest" "ImagingStudy" "Immunization" "ImmunizationRecommendation" "ImplementationGuide" "Library" "Linkage" "List" "Location" "Measure" "MeasureReport" "Media" "Medication" "MedicationAdministration" "MedicationDispense" "MedicationOrder" "MedicationStatement" "MessageHeader" "NamingSystem" "NutritionRequest" "Observation" "OperationDefinition" "OperationOutcome" "Organization" "Parameters" "Patient" "PaymentNotice" "PaymentReconciliation" "Person" "PlanDefinition" "Practitioner" "PractitionerRole" "Procedure" "ProcedureRequest" "ProcessRequest" "ProcessResponse" "Provenance" "Questionnaire" "QuestionnaireResponse" "ReferralRequest" "RelatedPerson" "Resource" "RiskAssessment" "Schedule" "SearchParameter" "Sequence" "Slot" "Specimen" "StructureDefinition" "StructureMap" "Subscription" "Substance" "SupplyDelivery" "SupplyRequest" "Task" "TestScript" "ValueSet" "VisionPrescription"]

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

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.