This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
Bundle.shex
Raw
ShEx
ShEx
statement
for
bundle
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=@<Bundle> AND {fhir:nodeRole [fhir:treeRoot]}
# Contains a collection of resources
<Bundle> CLOSED {
a [fhir:Bundle];
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:Bundle.identifier @<Identifier>?; # Persistent identifier for the
# bundle
fhir:Bundle.type @<code> AND
{fhir:value @fhirvs:bundle-type}; # document | message | transaction |
# transaction-response | batch |
# batch-response | history |
# searchset | collection
fhir:Bundle.total @<unsignedInt>?; # If search, the total number of
# matches
fhir:Bundle.link @<Bundle.link>*; # Links related to this Bundle
fhir:Bundle.entry @<Bundle.entry>*; # Entry in the bundle - will have a
# resource, or information
fhir:Bundle.signature @<Signature>?; # Digital Signature
fhir:index xsd:integer? # Relative position in a list
}
# Links related to this Bundle
<Bundle.link> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:Bundle.link.relation @<string>; # See
# http://www.iana.org/assignments/-
# link-relations/link-relations.xh-
# tml#link-relations-1
fhir:Bundle.link.url @<uri>; # Reference details for the link
fhir:index xsd:integer? # Relative position in a list
}
# Entry in the bundle - will have a resource, or information
<Bundle.entry> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:Bundle.entry.link @<Bundle.link>*; # Links related to this entry
fhir:Bundle.entry.fullUrl @<uri>?; # Absolute URL for resource (server
# address, or UUID/OID)
fhir:Bundle.entry.resource @<Resource>?; # A resource in the bundle
fhir:Bundle.entry.search @<Bundle.entry.search>?; # Search related information
fhir:Bundle.entry.request @<Bundle.entry.request>?; # Transaction Related Information
fhir:Bundle.entry.response @<Bundle.entry.response>?; # Transaction Related Information
fhir:index xsd:integer? # Relative position in a list
}
# Transaction Related Information
<Bundle.entry.request> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:Bundle.entry.request.method @<code> AND
{fhir:value @fhirvs:http-verb}; # GET | POST | PUT | DELETE
fhir:Bundle.entry.request.url @<uri>; # URL for HTTP equivalent of this
# entry
fhir:Bundle.entry.request.ifNoneMatch @<string>?; # For managing cache currency
fhir:Bundle.entry.request.ifModifiedSince @<instant>?; # For managing update contention
fhir:Bundle.entry.request.ifMatch @<string>?; # For managing update contention
fhir:Bundle.entry.request.ifNoneExist @<string>?; # For conditional creates
fhir:index xsd:integer? # Relative position in a list
}
# Search related information
<Bundle.entry.search> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:Bundle.entry.search.mode @<code> AND
{fhir:value @fhirvs:search-entry-mode}?; # match | include | outcome - why
# this is in the result set
fhir:Bundle.entry.search.score @<decimal>?; # Search ranking (between 0 and 1)
fhir:index xsd:integer? # Relative position in a list
}
# Transaction Related Information
<Bundle.entry.response> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:Bundle.entry.response.status @<string>; # Status response code (text
# optional)
fhir:Bundle.entry.response.location @<uri>?; # The location, if the operation
# returns a location
fhir:Bundle.entry.response.etag @<string>?; # The etag for the resource (if
# relevant)
fhir:Bundle.entry.response.lastModified @<instant>?; # Server's date time modified
fhir:Bundle.entry.response.outcome @<Resource>?; # OperationOutcome with hints and
# warnings (for batch/transaction)
fhir:index xsd:integer? # Relative position in a list
}
#---------------------- Data Types -------------------
# Metadata about a resource
<Meta> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:string?; # Primitive value for uri
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type instant
<instant> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:dateTime?; # Primitive value for instant
fhir:index xsd:integer? # Relative position in a list
}
# Optional Extensions Element
<Extension> CLOSED {
fhir:Element.id @<string>?;
fhir:Element.extension @<Extension>*;
fhir:Extension.url @<uri>;
(
fhir:Extension.valueBase64Binary @<base64Binary> |
fhir:Extension.valueBoolean @<boolean> |
fhir:Extension.valueCode @<code> |
fhir:Extension.valueDate @<date> |
fhir:Extension.valueDateTime @<dateTime> |
fhir:Extension.valueDecimal @<decimal> |
fhir:Extension.valueId @<id> |
fhir:Extension.valueInstant @<instant> |
fhir:Extension.valueInteger @<integer> |
fhir:Extension.valueMarkdown @<markdown> |
fhir:Extension.valueOid @<oid> |
fhir:Extension.valuePositiveInt @<positiveInt> |
fhir:Extension.valueString @<string> |
fhir:Extension.valueTime @<time> |
fhir:Extension.valueUnsignedInt @<unsignedInt> |
fhir:Extension.valueUri @<uri> |
fhir:Extension.valueAddress @<Address> |
fhir:Extension.valueAge @<Age> |
fhir:Extension.valueAnnotation @<Annotation> |
fhir:Extension.valueAttachment @<Attachment> |
fhir:Extension.valueCodeableConcept @<CodeableConcept> |
fhir:Extension.valueCoding @<Coding> |
fhir:Extension.valueContactPoint @<ContactPoint> |
fhir:Extension.valueCount @<Count> |
fhir:Extension.valueDistance @<Distance> |
fhir:Extension.valueDuration @<Duration> |
fhir:Extension.valueHumanName @<HumanName> |
fhir:Extension.valueIdentifier @<Identifier> |
fhir:Extension.valueMoney @<Money> |
fhir:Extension.valuePeriod @<Period> |
fhir:Extension.valueQuantity @<Quantity> |
fhir:Extension.valueRange @<Range> |
fhir:Extension.valueRatio @<Ratio> |
fhir:Extension.valueReference @<Reference> |
fhir:Extension.valueSampledData @<SampledData> |
fhir:Extension.valueSignature @<Signature> |
fhir:Extension.valueTiming @<Timing> |
fhir:Extension.valueMeta @<Meta>
)?;
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:Element.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
# value
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 @<Reference>?; # Organization that issued id (may
# be just text)
fhir:index xsd:integer? # Relative position in a list
}
# A digital Signature - XML DigSig, JWT, Graphical image of signature, etc.
<Signature> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Signature.type @<Coding>+; # Indication of the reason the
# entity signed the object(s)
fhir:Signature.when @<instant>; # When the signature was created
( # Who signed
fhir:Signature.whoUri @<uri> |
fhir:Signature.whoReference @<Reference> |
fhir:Signature.whoReference @<Reference> |
fhir:Signature.whoReference @<Reference> |
fhir:Signature.whoReference @<Reference> |
fhir:Signature.whoReference @<Reference>
);
( # The party represented
fhir:Signature.onBehalfOfUri @<uri> |
fhir:Signature.onBehalfOfReference @<Reference> |
fhir:Signature.onBehalfOfReference @<Reference> |
fhir:Signature.onBehalfOfReference @<Reference> |
fhir:Signature.onBehalfOfReference @<Reference> |
fhir:Signature.onBehalfOfReference @<Reference>
)?;
fhir:Signature.contentType @<code>?; # The technical format of the
# signature
fhir:Signature.blob @<base64Binary>?; # The actual signature content (XML
# DigSig. JWT, picture, etc.)
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type unsignedInt
<unsignedInt> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:decimal?; # Primitive value for decimal
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type date
<date> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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
}
# Primitive Type dateTime
<dateTime> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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
}
# An address expressed using postal conventions (as opposed to GPS or other location definition formats)
<Address> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Address.use @<code> AND
{fhir:value @fhirvs:address-use}?; # home | work | temp | old - purpose
# of this address
fhir:Address.type @<code> AND
{fhir:value @fhirvs:address-type}?; # postal | physical | both
fhir:Address.text @<string>?; # Text representation of the address
fhir:Address.line @<string>*; # Street name, number, direction &
# P.O. Box etc.
fhir:Address.city @<string>?; # Name of city, town etc.
fhir:Address.district @<string>?; # District name (aka county)
fhir:Address.state @<string>?; # Sub-unit of country (abbreviations
# ok)
fhir:Address.postalCode @<string>?; # Postal code for area
fhir:Address.country @<string>?; # Country (e.g. can be ISO 3166 2 or
# 3 letter code)
fhir:Address.period @<Period>?; # Time period when address was/is in
# use
fhir:index xsd:integer? # Relative position in a list
}
# Content in a format defined elsewhere
<Attachment> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Attachment.contentType @<code>?; # Mime type of the content, with
# charset etc.
fhir:Attachment.language @<code>?; # Human language of the content
# (BCP-47)
fhir:Attachment.data @<base64Binary>?; # Data inline, base64ed
fhir:Attachment.url @<uri>?; # Uri where the data can be found
fhir:Attachment.size @<unsignedInt>?; # Number of bytes of content (if url
# provided)
fhir:Attachment.hash @<base64Binary>?; # Hash of the data (sha-1, base64ed)
fhir:Attachment.title @<string>?; # Label to display in place of the
# data
fhir:Attachment.creation @<dateTime>?; # Date attachment was first created
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type integer
<integer> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:integer MININCLUSIVE "-2147483648"^^xsd:integer MAXINCLUSIVE "2147483647"^^xsd:integer?; # Primitive value for integer
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type oid
<oid> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:string?; # Primitive value for oid
fhir:index xsd:integer? # Relative position in a list
}
# A measured or measurable amount
<Count> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# Details of a Technology mediated contact point (phone, fax, email, etc.)
<ContactPoint> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:ContactPoint.system @<code> AND
{fhir:value @fhirvs:contact-point-system}?; # phone | fax | email | pager | url
# | sms | 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
}
# Name of a human - parts and usage
<HumanName> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:HumanName.use @<code> AND
{fhir:value @fhirvs:name-use}?; # usual | official | temp | nickname
# | anonymous | old | maiden
fhir:HumanName.text @<string>?; # Text representation of the full
# name
fhir:HumanName.family @<string>?; # Family name (often called
# 'Surname')
fhir:HumanName.given @<string>*; # Given names (not always 'first').
# Includes middle names
fhir:HumanName.prefix @<string>*; # Parts that come before the name
fhir:HumanName.suffix @<string>*; # Parts that come after the name
fhir:HumanName.period @<Period>?; # Time period when name was/is in use
fhir:index xsd:integer? # Relative position in a list
}
# An amount of economic utility in some recognized currency
<Money> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A reference to a code defined by a terminology system
<Coding> CLOSED {
a NONLITERAL?;
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:string?; # Primitive value for markdown
fhir:index xsd:integer? # Relative position in a list
}
# A series of measurements taken by a device
<SampledData> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:SampledData.origin @<SimpleQuantity>; # Zero value and units
fhir:SampledData.period @<decimal>; # Number of milliseconds between
# samples
fhir:SampledData.factor @<decimal>?; # Multiply data by this before
# adding to origin
fhir:SampledData.lowerLimit @<decimal>?; # Lower limit of detection
fhir:SampledData.upperLimit @<decimal>?; # Upper limit of detection
fhir:SampledData.dimensions @<positiveInt>; # Number of sample points at each
# time point
fhir:SampledData.data @<string>; # Decimal values with spaces, or "E"
# | "U" | "L"
fhir:index xsd:integer? # Relative position in a list
}
# A ratio of two Quantity values - a numerator and a denominator
<Ratio> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Ratio.numerator @<Quantity>?; # Numerator value
fhir:Ratio.denominator @<Quantity>?; # Denominator value
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type positiveInt
<positiveInt> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:positiveInteger?; # Primitive value for positiveInt
fhir:index xsd:integer? # Relative position in a list
}
# A duration of time during which an organism (or a process) has existed
<Age> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A length - a value with a unit that is a physical distance
<Distance> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A reference from one resource to another
<Reference> CLOSED {
fhir:link IRI?;
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Reference.reference @<string>?; # Literal reference, Relative,
# internal or absolute URL
fhir:Reference.identifier @<Identifier>?; # Logical reference, when literal
# reference is not known
fhir:Reference.display @<string>?; # Text alternative for the resource
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:Element.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
}
# A measured or measurable amount
<Quantity> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A length of time
<Duration> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @<code> AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# Set of values bounded by low and high
<Range> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Range.low @<SimpleQuantity>?; # Low limit
fhir:Range.high @<SimpleQuantity>?; # High limit
fhir:index xsd:integer? # Relative position in a list
}
# Text node with attribution
<Annotation> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
( # Individual responsible for the
# annotation
fhir:Annotation.authorReference @<Reference> |
fhir:Annotation.authorReference @<Reference> |
fhir:Annotation.authorReference @<Reference> |
fhir:Annotation.authorString @<string>
)?;
fhir:Annotation.time @<dateTime>?; # When the annotation was made
fhir:Annotation.text @<string>; # The annotation - text content
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type boolean
<boolean> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:boolean?; # Primitive value for boolean
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type base64Binary
<base64Binary> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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 time
<time> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:value xsd:time?; # Primitive value for time
fhir:index xsd:integer? # Relative position in a list
}
# A timing schedule that specifies an event that may occur multiple times
<Timing> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Timing.event @<dateTime>*; # When the event occurs
fhir:Timing.repeat @<Timing.repeat>?; # When the event is to occur
fhir:Timing.code @<CodeableConcept>?; # BID | TID | QID | AM | PM | QD |
# QOD | Q4H | Q6H +
fhir:index xsd:integer? # Relative position in a list
}
# Concept - reference to a terminology or just text
<CodeableConcept> CLOSED {
a NONLITERAL*;
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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
}
# A fixed quantity (no comparator)
<SimpleQuantity> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Quantity.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Quantity.unit @<string>?; # Unit representation
fhir:Quantity.system @<uri>?; # System that defines coded unit form
fhir:Quantity.code @<code>?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# When the event is to occur
<Timing.repeat> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
( # Length/Range of lengths, or (Start
# and/or end) limits
fhir:Timing.repeat.boundsDuration @<Duration> |
fhir:Timing.repeat.boundsRange @<Range> |
fhir:Timing.repeat.boundsPeriod @<Period>
)?;
fhir:Timing.repeat.count @<integer>?; # Number of times to repeat
fhir:Timing.repeat.countMax @<integer>?; # Maximum number of times to repeat
fhir:Timing.repeat.duration @<decimal>?; # How long when it happens
fhir:Timing.repeat.durationMax @<decimal>?; # How long when it happens (Max)
fhir:Timing.repeat.durationUnit @<code> AND
{fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a -
# unit of time (UCUM)
fhir:Timing.repeat.frequency @<integer>?; # Event occurs frequency times per
# period
fhir:Timing.repeat.frequencyMax @<integer>?; # Event occurs up to frequencyMax
# times per period
fhir:Timing.repeat.period @<decimal>?; # Event occurs frequency times per
# period
fhir:Timing.repeat.periodMax @<decimal>?; # Upper limit of period (3-4 hours)
fhir:Timing.repeat.periodUnit @<code> AND
{fhir:value @fhirvs:units-of-time}?; # s | min | h | d | wk | mo | a -
# unit of time (UCUM)
fhir:Timing.repeat.dayOfWeek @<code> AND
{fhir:value @fhirvs:days-of-week}*; # mon | tue | wed | thu | fri | sat
# | sun
fhir:Timing.repeat.timeOfDay @<time>*; # Time of day for action
fhir:Timing.repeat.when @<code> AND
{fhir:value @fhirvs:event-timing}*; # Regular life events the event is
# tied to
fhir:Timing.repeat.offset @<unsignedInt>?; # Minutes from event (before or
# after)
fhir:index xsd:integer? # Relative position in a list
}
#---------------------- Reference Types -------------------
#---------------------- Value Sets ------------------------
# Use of contact point
fhirvs:contact-point-use ["home" "work" "temp" "old" "mobile"]
# HTTP verbs (in the HTTP command line).
fhirvs:http-verb ["GET" "POST" "PUT" "DELETE"]
# The days of the week.
fhirvs:days-of-week ["mon" "tue" "wed" "thu" "fri" "sat" "sun"]
# Why an entry is in the result set - whether it's included as a match or because of an _include requirement.
fhirvs:search-entry-mode ["match" "include" "outcome"]
# How the Quantity should be understood and represented.
fhirvs:quantity-comparator ["<" "<=" ">=" ">"]
# The type of an address (physical / postal)
fhirvs:address-type ["postal" "physical" "both"]
# Real world event relating to the schedule.
fhirvs:event-timing ["MORN" "AFT" "EVE" "NIGHT" "PHS" "HS" "WAKE" "C" "CM" "CD" "CV" "AC" "ACM" "ACD" "ACV" "PC" "PCM" "PCD" "PCV"]
# Identifies the purpose for this identifier, if known .
fhirvs:identifier-use ["usual" "official" "temp" "secondary"]
# A unit of time (units from UCUM).
fhirvs:units-of-time ["s" "min" "h" "d" "wk" "mo" "a"]
# The use of an address
fhirvs:address-use ["home" "work" "temp" "old"]
# The use of a human name
fhirvs:name-use ["usual" "official" "temp" "nickname" "anonymous" "old" "maiden"]
# Telecommunications form for contact point
fhirvs:contact-point-system ["phone" "fax" "email" "pager" "url" "sms" "other"]
# Indicates the purpose of a bundle - how it was intended to be used.
fhirvs:bundle-type ["document" "message" "transaction" "transaction-response" "batch" "batch-response" "history" "searchset" "collection"]
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#>
# ShEx Version 2.2
IMPORT <Uri.shex>
IMPORT <Code.shex>
IMPORT <String.shex>
IMPORT <Instant.shex>
IMPORT <Decimal.shex>
IMPORT <Resource.shex>
IMPORT <Signature.shex>
IMPORT <Identifier.shex>
IMPORT <UnsignedInt.shex>
IMPORT <BackboneElement.shex>
start=@<Bundle> AND {fhir:nodeRole [fhir:treeRoot]}
# Contains a collection of resources
<Bundle> EXTENDS @<Resource> CLOSED {
a [fhir:Bundle]?;fhir:nodeRole [fhir:treeRoot]?;
fhir:identifier @<Identifier>?; # Persistent identifier for the
# bundle
fhir:type @<Code> AND
{fhir:v @fhirvs:bundle-type}; # document | message | transaction |
# transaction-response | batch |
# batch-response | history |
# searchset | collection |
# subscription-notification
fhir:timestamp @<Instant>?; # When the bundle was assembled
fhir:total @<UnsignedInt>?; # Total matches across all pages
fhir:link @<OneOrMore_Bundle.link>?; # Links related to this Bundle
fhir:entry @<OneOrMore_Bundle.entry>?; # Entry in the bundle - will have a
# resource or information
fhir:signature @<Signature>?; # Digital Signature (deprecated: use
# Provenance Signatures)
fhir:issues @<Resource>?; # OperationOutcome with issues about
# the Bundle
}
# Links related to this Bundle
<Bundle.link> EXTENDS @<BackboneElement> CLOSED {
fhir:relation @<Code> AND
{fhir:v @fhirvs:iana-link-relations}; # See
# http://www.iana.org/assignments/-
# link-relations/link-relations.xh-
# tml#link-relations-1
fhir:url @<Uri>; # Reference details for the link
}
# Search related information
<Bundle.entry.search> EXTENDS @<BackboneElement> CLOSED {
fhir:mode @<Code> AND
{fhir:v @fhirvs:search-entry-mode}?; # match | include - why this is in
# the result set
fhir:score @<Decimal>?; # Search ranking (between 0 and 1)
}
# Additional execution information (transaction/batch/history)
<Bundle.entry.request> EXTENDS @<BackboneElement> CLOSED {
fhir:method @<Code> AND
{fhir:v @fhirvs:http-verb}; # GET | HEAD | POST | PUT | DELETE |
# PATCH
fhir:url @<Uri>; # URL for HTTP equivalent of this
# entry
fhir:ifNoneMatch @<String>?; # For managing cache validation
fhir:ifModifiedSince @<Instant>?; # For managing cache currency
fhir:ifMatch @<String>?; # For managing update contention
fhir:ifNoneExist @<String>?; # For conditional creates
}
# Results of execution (transaction/batch/history)
<Bundle.entry.response> EXTENDS @<BackboneElement> CLOSED {
fhir:status @<String>; # Status response code (text
# optional)
fhir:location @<Uri>?; # The location (if the operation
# returns a location)
fhir:etag @<String>?; # The Etag for the resource (if
# relevant)
fhir:lastModified @<Instant>?; # Server's date time modified
fhir:outcome @<Resource>?; # OperationOutcome with hints and
# warnings (for batch/transaction)
}
# Entry in the bundle - will have a resource or information
<Bundle.entry> EXTENDS @<BackboneElement> CLOSED {
fhir:link @<OneOrMore_Bundle.link>?; # Links related to this entry
fhir:fullUrl @<Uri>?; # URI for resource (e.g. the
# absolute URL server address, URI
# for UUID/OID, etc.)
fhir:resource @<Resource>?; # A resource in the bundle
fhir:search @<Bundle.entry.search>?; # Search related information
fhir:request @<Bundle.entry.request>?; # Additional execution information
# (transaction/batch/history)
fhir:response @<Bundle.entry.response>?; # Results of execution
# (transaction/batch/history)
}
#---------------------- Cardinality Types (OneOrMore) -------------------
<OneOrMore_Bundle.link> CLOSED {
rdf:first @<Bundle.link> ;
rdf:rest [rdf:nil] OR @<OneOrMore_Bundle.link>
}
<OneOrMore_Bundle.entry> CLOSED {
rdf:first @<Bundle.entry> ;
rdf:rest [rdf:nil] OR @<OneOrMore_Bundle.entry>
}
#---------------------- Value Sets ------------------------
# Indicates the purpose of a bundle - how it is intended to be used.
fhirvs:bundle-type ["document" "message" "transaction" "transaction-response" "batch" "batch-response" "history" "searchset" "collection" "subscription-notification"]
# HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.
fhirvs:http-verb ["GET" "HEAD" "POST" "PUT" "DELETE" "PATCH"]
# Link Relation Types defined at https://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
fhirvs:iana-link-relations ["about" "acl" "alternate" "amphtml" "appendix" "apple-touch-icon" "apple-touch-startup-image" "archives" "author" "blocked-by" "bookmark" "canonical" "chapter" "cite-as" "collection" "contents" "convertedFrom" "copyright" "create-form" "current" "describedby" "describes" "disclosure" "dns-prefetch" "duplicate" "edit" "edit-form" "edit-media" "enclosure" "external" "first" "glossary" "help" "hosts" "hub" "icon" "index" "intervalAfter" "intervalBefore" "intervalContains" "intervalDisjoint" "intervalDuring" "intervalEquals" "intervalFinishedBy" "intervalFinishes" "intervalIn" "intervalMeets" "intervalMetBy" "intervalOverlappedBy" "intervalOverlaps" "intervalStartedBy" "intervalStarts" "item" "last" "latest-version" "license" "linkset" "lrdd" "manifest" "mask-icon" "media-feed" "memento" "micropub" "modulepreload" "monitor" "monitor-group" "next" "next-archive" "nofollow" "noopener" "noreferrer" "opener" "openid2.local_id" "openid2.provider" "original" "P3Pv1" "payment" "pingback" "preconnect" "predecessor-version" "prefetch" "preload" "prerender" "prev" "preview" "previous" "prev-archive" "privacy-policy" "profile" "publication" "related" "restconf" "replies" "ruleinput" "search" "section" "self" "service" "service-desc" "service-doc" "service-meta" "sponsored" "start" "status" "stylesheet" "subsection" "successor-version" "sunset" "tag" "terms-of-service" "timegate" "timemap" "type" "ugc" "up" "version-history" "via" "webmention" "working-copy" "working-copy-of"]
# Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
fhirvs:search-entry-mode ["match" "include" "outcome"]
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.
|
Propose
a
change
Foundation