ShEx
statement
for
activitydefinition
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=@<ActivityDefinition> AND {fhir:nodeRole [fhir:treeRoot]}
# The definition of a specific activity to be taken, independent of any particular patient or context
<ActivityDefinition> CLOSED {
a [fhir:ActivityDefinition];
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:DomainResource.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:DomainResource.modifierExtension @<Extension>*; # Extensions that cannot be ignored
fhir:ActivityDefinition.url @<uri>?; # Logical URI to reference this
# activity definition (globally
# unique)
fhir:ActivityDefinition.identifier @<Identifier>*; # Additional identifier for the
# activity definition
fhir:ActivityDefinition.version @<string>?; # Business version of the activity
# definition
fhir:ActivityDefinition.name @<string>?; # Name for this activity definition
# (computer friendly)
fhir:ActivityDefinition.title @<string>?; # Name for this activity definition
# (human friendly)
fhir:ActivityDefinition.status @<code> AND
{fhir:value @fhirvs:publication-status}; # draft | active | retired | unknown
fhir:ActivityDefinition.experimental @<boolean>?; # For testing purposes, not real
# usage
fhir:ActivityDefinition.date @<dateTime>?; # Date this was last changed
fhir:ActivityDefinition.publisher @<string>?; # Name of the publisher
# (organization or individual)
fhir:ActivityDefinition.description @<markdown>?; # Natural language description of
# the activity definition
fhir:ActivityDefinition.purpose @<markdown>?; # Why this activity definition is
# defined
fhir:ActivityDefinition.usage @<string>?; # Describes the clinical usage of
# the asset
fhir:ActivityDefinition.approvalDate @<date>?; # When the activity definition was
# approved by publisher
fhir:ActivityDefinition.lastReviewDate @<date>?; # When the activity definition was
# last reviewed
fhir:ActivityDefinition.effectivePeriod @<Period>?; # When the activity definition is
# expected to be used
fhir:ActivityDefinition.useContext @<UsageContext>*; # Context the content is intended to
# support
fhir:ActivityDefinition.jurisdiction @<CodeableConcept>*; # Intended jurisdiction for activity
# definition (if applicable)
fhir:ActivityDefinition.topic @<CodeableConcept>*; # E.g. Education, Treatment,
# Assessment, etc
fhir:ActivityDefinition.contributor @<Contributor>*; # A content contributor
fhir:ActivityDefinition.contact @<ContactDetail>*; # Contact details for the publisher
fhir:ActivityDefinition.copyright @<markdown>?; # Use and/or publishing restrictions
fhir:ActivityDefinition.relatedArtifact @<RelatedArtifact>*; # Additional documentation,
# citations, etc
fhir:ActivityDefinition.library @<Reference>*; # Logic used by the asset
fhir:ActivityDefinition.kind @<code> AND
{fhir:value @fhirvs:resource-types}?; # Kind of resource
fhir:ActivityDefinition.code @<CodeableConcept>?; # Detail type of activity
( # When activity is to occur
fhir:ActivityDefinition.timingTiming @<Timing> |
fhir:ActivityDefinition.timingDateTime @<dateTime> |
fhir:ActivityDefinition.timingPeriod @<Period> |
fhir:ActivityDefinition.timingRange @<Range>
)?;
fhir:ActivityDefinition.location @<Reference>?; # Where it should happen
fhir:ActivityDefinition.participant @<ActivityDefinition.participant>*; # Who should participate in the
# action
( # What's administered/supplied
fhir:ActivityDefinition.productReference @<Reference> |
fhir:ActivityDefinition.productReference @<Reference> |
fhir:ActivityDefinition.productCodeableConcept @<CodeableConcept>
)?;
fhir:ActivityDefinition.quantity @<SimpleQuantity>?; # How much is
# administered/consumed/supplied
fhir:ActivityDefinition.dosage @<Dosage>*; # Detailed dosage instructions
fhir:ActivityDefinition.bodySite @<CodeableConcept>*; # What part of body to perform on
fhir:ActivityDefinition.transform @<Reference>?; # Transform to apply the template
fhir:ActivityDefinition.dynamicValue @<ActivityDefinition.dynamicValue>*; # Dynamic aspects of the definition
fhir:index xsd:integer? # Relative position in a list
}
# Dynamic aspects of the definition
<ActivityDefinition.dynamicValue> 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:ActivityDefinition.dynamicValue.description @<string>?; # Natural language description of
# the dynamic value
fhir:ActivityDefinition.dynamicValue.path @<string>?; # The path to the element to be set
# dynamically
fhir:ActivityDefinition.dynamicValue.language @<string>?; # Language of the expression
fhir:ActivityDefinition.dynamicValue.expression @<string>?; # An expression that provides the
# dynamic value for the
# customization
fhir:index xsd:integer? # Relative position in a list
}
# Who should participate in the action
<ActivityDefinition.participant> 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:ActivityDefinition.participant.type @<code> AND
{fhir:value @fhirvs:action-participant-type}; # patient | practitioner |
# related-person
fhir:ActivityDefinition.participant.role @<CodeableConcept>?; # E.g. Nurse, Surgeon, Parent, etc
fhir:index xsd:integer? # Relative position in a list
}
#---------------------- Data Types -------------------
# 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
}
# 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
}
# 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
}
# Contributor information
<Contributor> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Contributor.type @<code> AND
{fhir:value @fhirvs:contributor-type}; # author | editor | reviewer |
# endorser
fhir:Contributor.name @<string>; # Who contributed the content
fhir:Contributor.contact @<ContactDetail>*; # Contact details of the contributor
fhir:index xsd:integer? # Relative position in a list
}
# How the medication is/was taken or should be taken
<Dosage> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:Dosage.sequence @<integer>?; # The order of the dosage
# instructions
fhir:Dosage.text @<string>?; # Free text dosage instructions e.g.
# SIG
fhir:Dosage.additionalInstruction @<CodeableConcept>*; # Supplemental instruction - e.g.
# "with meals"
fhir:Dosage.patientInstruction @<string>?; # Patient or consumer oriented
# instructions
fhir:Dosage.timing @<Timing>?; # When medication should be
# administered
( # Take "as needed" (for x)
fhir:Dosage.asNeededBoolean @<boolean> |
fhir:Dosage.asNeededCodeableConcept @<CodeableConcept>
)?;
fhir:Dosage.site @<CodeableConcept>?; # Body site to administer to
fhir:Dosage.route @<CodeableConcept>?; # How drug should enter body
fhir:Dosage.method @<CodeableConcept>?; # Technique for administering
# medication
( # Amount of medication per dose
fhir:Dosage.doseRange @<Range> |
fhir:Dosage.doseQuantity @<SimpleQuantity>
)?;
fhir:Dosage.maxDosePerPeriod @<Ratio>?; # Upper limit on medication per unit
# of time
fhir:Dosage.maxDosePerAdministration @<SimpleQuantity>?; # Upper limit on medication per
# administration
fhir:Dosage.maxDosePerLifetime @<SimpleQuantity>?; # Upper limit on medication per
# lifetime of the patient
( # Amount of medication per unit of
# time
fhir:Dosage.rateRatio @<Ratio> |
fhir:Dosage.rateRange @<Range> |
fhir:Dosage.rateQuantity @<SimpleQuantity>
)?;
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 human-readable formatted text, including images
<Narrative> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.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
}
# 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
}
# 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
}
# 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
}
# 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?
}
# 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
}
# 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
}
# Related artifacts for a knowledge resource
<RelatedArtifact> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:RelatedArtifact.type @<code> AND
{fhir:value @fhirvs:related-artifact-type}; # documentation | justification |
# citation | predecessor | successor
# | derived-from | depends-on |
# composed-of
fhir:RelatedArtifact.display @<string>?; # Brief description of the related
# artifact
fhir:RelatedArtifact.citation @<string>?; # Bibliographic citation for the
# artifact
fhir:RelatedArtifact.url @<uri>?; # Where the artifact can be accessed
fhir:RelatedArtifact.document @<Attachment>?; # What document is being referenced
fhir:RelatedArtifact.resource @<Reference>?; # What resource is being referenced
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
}
# 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
}
# 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
}
# Contact information
<ContactDetail> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:ContactDetail.name @<string>?; # Name of an individual to contact
fhir:ContactDetail.telecom @<ContactPoint>*; # Contact details for individual or
# organization
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
}
# Describes the context of use for a conformance or knowledge resource
<UsageContext> CLOSED {
fhir:Element.id @<string>?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional Content defined by
# implementations
fhir:UsageContext.code @<Coding>; # Type of context being specified
( # Value that defines the context
fhir:UsageContext.valueCodeableConcept @<CodeableConcept> |
fhir:UsageContext.valueQuantity @<Quantity> |
fhir:UsageContext.valueRange @<Range>
);
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
}
# 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
}
# 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
}
# 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
}
# 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 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
}
# 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 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
}
# 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 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
}
# 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
}
# 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 ------------------------
# The status of a resource narrative
fhirvs:narrative-status ["generated" "extensions" "additional" "empty"]
# Use of contact point
fhirvs:contact-point-use ["home" "work" "temp" "old" "mobile"]
# The days of the week.
fhirvs:days-of-week ["mon" "tue" "wed" "thu" "fri" "sat" "sun"]
# The type of participant for the action
fhirvs:action-participant-type ["patient" "practitioner" "related-person"]
# The type of contributor
fhirvs:contributor-type ["author" "editor" "reviewer" "endorser"]
# How the Quantity should be understood and represented.
fhirvs:quantity-comparator ["<" "<=" ">=" ">"]
# One of the resource types defined as part of FHIR.
fhirvs:resource-types ["Account" "ActivityDefinition" "AdverseEvent" "AllergyIntolerance" "Appointment" "AppointmentResponse" "AuditEvent" "Basic" "Binary" "BodySite" "Bundle" "CapabilityStatement" "CarePlan" "CareTeam" "ChargeItem" "Claim" "ClaimResponse" "ClinicalImpression" "CodeSystem" "Communication" "CommunicationRequest" "CompartmentDefinition" "Composition" "ConceptMap" "Condition" "Consent" "Contract" "Coverage" "DataElement" "DetectedIssue" "Device" "DeviceComponent" "DeviceMetric" "DeviceRequest" "DeviceUseStatement" "DiagnosticReport" "DocumentManifest" "DocumentReference" "DomainResource" "EligibilityRequest" "EligibilityResponse" "Encounter" "Endpoint" "EnrollmentRequest" "EnrollmentResponse" "EpisodeOfCare" "ExpansionProfile" "ExplanationOfBenefit" "FamilyMemberHistory" "Flag" "Goal" "GraphDefinition" "Group" "GuidanceResponse" "HealthcareService" "ImagingManifest" "ImagingStudy" "Immunization" "ImmunizationRecommendation" "ImplementationGuide" "Library" "Linkage" "List" "Location" "Measure" "MeasureReport" "Media" "Medication" "MedicationAdministration" "MedicationDispense" "MedicationRequest" "MedicationStatement" "MessageDefinition" "MessageHeader" "NamingSystem" "NutritionOrder" "Observation" "OperationDefinition" "OperationOutcome" "Organization" "Parameters" "Patient" "PaymentNotice" "PaymentReconciliation" "Person" "PlanDefinition" "Practitioner" "PractitionerRole" "Procedure" "ProcedureRequest" "ProcessRequest" "ProcessResponse" "Provenance" "Questionnaire" "QuestionnaireResponse" "ReferralRequest" "RelatedPerson" "RequestGroup" "ResearchStudy" "ResearchSubject" "Resource" "RiskAssessment" "Schedule" "SearchParameter" "Sequence" "ServiceDefinition" "Slot" "Specimen" "StructureDefinition" "StructureMap" "Subscription" "Substance" "SupplyDelivery" "SupplyRequest" "Task" "TestReport" "TestScript" "ValueSet" "VisionPrescription"]
# The lifecycle status of a Value Set or Concept Map.
fhirvs:publication-status ["draft" "active" "retired" "unknown"]
# 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"]
# The type of relationship to the related artifact
fhirvs:related-artifact-type ["documentation" "justification" "citation" "predecessor" "successor" "derived-from" "depends-on" "composed-of"]
# 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"]
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 <Age.shex>
IMPORT <Code.shex>
IMPORT <Date.shex>
IMPORT <Group.shex>
IMPORT <Range.shex>
IMPORT <String.shex>
IMPORT <Coding.shex>
IMPORT <Period.shex>
IMPORT <Timing.shex>
IMPORT <Dosage.shex>
IMPORT <Device.shex>
IMPORT <Boolean.shex>
IMPORT <Patient.shex>
IMPORT <DateTime.shex>
IMPORT <Markdown.shex>
IMPORT <Duration.shex>
IMPORT <Quantity.shex>
IMPORT <CareTeam.shex>
IMPORT <Endpoint.shex>
IMPORT <Location.shex>
IMPORT <Specimen.shex>
IMPORT <Reference.shex>
IMPORT <Canonical.shex>
IMPORT <Substance.shex>
IMPORT <Identifier.shex>
IMPORT <Medication.shex>
IMPORT <Ingredient.shex>
IMPORT <Expression.shex>
IMPORT <UsageContext.shex>
IMPORT <RelativeTime.shex>
IMPORT <Organization.shex>
IMPORT <Practitioner.shex>
IMPORT <ContactDetail.shex>
IMPORT <RelatedPerson.shex>
IMPORT <DomainResource.shex>
IMPORT <CodeableConcept.shex>
IMPORT <RelatedArtifact.shex>
IMPORT <BackboneElement.shex>
IMPORT <EvidenceVariable.shex>
IMPORT <PractitionerRole.shex>
IMPORT <CodeableReference.shex>
IMPORT <HealthcareService.shex>
IMPORT <SubstanceDefinition.shex>
IMPORT <PackagedProductDefinition.shex>
IMPORT <MedicinalProductDefinition.shex>
IMPORT <ManufacturedItemDefinition.shex>
IMPORT <BiologicallyDerivedProduct.shex>
IMPORT <AdministrableProductDefinition.shex>
start=@<ActivityDefinition> AND {fhir:nodeRole [fhir:treeRoot]}
# The definition of a specific activity to be taken, independent of any particular patient or context
<ActivityDefinition> EXTENDS @<DomainResource> CLOSED {
a [fhir:ActivityDefinition]?;fhir:nodeRole [fhir:treeRoot]?;
fhir:url @<Uri>?; # Canonical identifier for this
# activity definition, represented
# as a URI (globally unique)
fhir:identifier @<OneOrMore_Identifier>?; # Additional identifier for the
# activity definition
fhir:version @<String>?; # Business version of the activity
# definition
fhir:versionAlgorithm @<String> OR
@<Coding> ?; # How to compare versions
fhir:name @<String>?; # Name for this activity definition
# (computer friendly)
fhir:title @<String>?; # Name for this activity definition
# (human friendly)
fhir:subtitle @<String>?; # Subordinate title of the activity
# definition
fhir:status @<Code> AND
{fhir:v @fhirvs:publication-status}; # draft | active | retired | unknown
fhir:experimental @<Boolean>?; # For testing only - never for real
# usage
fhir:subject @<CodeableConcept> OR
(@<Reference> AND {fhir:l @<Group> OR
@<MedicinalProductDefinition> OR
@<SubstanceDefinition> OR
@<AdministrableProductDefinition> OR
@<ManufacturedItemDefinition> OR
@<PackagedProductDefinition> }) OR
(@<Canonical> AND {fhir:l @<EvidenceVariable> }) ?; # Type of individual the activity
# definition is intended for
fhir:date @<DateTime>?; # Date last changed
fhir:publisher @<String>?; # Name of the publisher/steward
# (organization or individual)
fhir:contact @<OneOrMore_ContactDetail>?; # Contact details for the publisher
fhir:description @<Markdown>?; # Natural language description of
# the activity definition
fhir:useContext @<OneOrMore_UsageContext>?; # The context that the content is
# intended to support
fhir:jurisdiction @<OneOrMore_CodeableConcept>?; # Jurisdiction of the authority that
# maintains the activity definition
# (if applicable)
fhir:purpose @<Markdown>?; # Why this activity definition is
# defined
fhir:usage @<Markdown>?; # Describes the clinical usage of
# the activity definition
fhir:copyright @<Markdown>?; # Notice about intellectual property
# ownership, can include
# restrictions on use
fhir:copyrightLabel @<String>?; # Copyright holder and year(s)
fhir:approvalDate @<Date>?; # When the activity definition was
# approved by publisher
fhir:lastReviewDate @<Date>?; # When the activity definition was
# last reviewed by the publisher
fhir:effectivePeriod @<Period>?; # When the activity definition is
# expected to be used
fhir:topic @<OneOrMore_CodeableConcept>?; # E.g. Education, Treatment,
# Assessment, etc
fhir:author @<OneOrMore_ContactDetail>?; # Who authored the content
fhir:editor @<OneOrMore_ContactDetail>?; # Who edited the content
fhir:reviewer @<OneOrMore_ContactDetail>?; # Who reviewed the content
fhir:endorser @<OneOrMore_ContactDetail>?; # Who endorsed the content
fhir:relatedArtifact @<OneOrMore_RelatedArtifact>?; # Additional documentation,
# citations, etc
fhir:library @<OneOrMore_Canonical>?; # Logic used by the activity
# definition
fhir:kind @<Code> AND
{fhir:v @fhirvs:request-resource-types}?; # Kind of resource
fhir:profile @<Canonical>?; # What profile the resource needs to
# conform to
fhir:code @<CodeableConcept>?; # Detail type of activity
fhir:intent @<Code> AND
{fhir:v @fhirvs:request-intent}?; # proposal | solicit-offer |
# offer-response | plan | directive
# | order | original-order |
# reflex-order | filler-order |
# instance-order | option
fhir:priority @<Code> AND
{fhir:v @fhirvs:request-priority}?; # routine | urgent | asap | stat
fhir:doNotPerform @<Boolean>?; # True if the activity should not be
# performed
fhir:timing @<Timing> OR
@<Age> OR
@<Range> OR
@<Duration> OR
@<RelativeTime> ?; # When activity is to occur
fhir:asNeeded @<Boolean> OR
@<CodeableConcept> ?; # Preconditions for service
fhir:location @<CodeableReference>?; # Where it should happen
fhir:participant @<OneOrMore_ActivityDefinition.participant>?; # Who should participate in the
# action
fhir:product (@<Reference> AND {fhir:l @<Medication> OR
@<MedicinalProductDefinition> OR
@<Ingredient> OR
@<SubstanceDefinition> }) OR
@<CodeableConcept> ?; # What's administered/supplied
fhir:quantity @<Quantity>?; # How much is
# administered/consumed/supplied
fhir:dosage @<OneOrMore_Dosage>?; # Detailed dosage instructions
fhir:bodySite @<OneOrMore_CodeableConcept>?; # What part of body to perform on
fhir:specimenRequirement @<OneOrMore_Canonical>?; # What specimens are required to
# perform this action
fhir:observationRequirement @<OneOrMore_Canonical>?; # What observations are required to
# perform this action
fhir:observationResultRequirement @<OneOrMore_Canonical>?; # What observations must be produced
# by this action
fhir:transform @<Canonical>?; # Transform to apply the template
fhir:dynamicValue @<OneOrMore_ActivityDefinition.dynamicValue>?; # Dynamic aspects of the definition
}
# Who should participate in the action
<ActivityDefinition.participant> EXTENDS @<BackboneElement> CLOSED {
fhir:type @<Code> AND
{fhir:v @fhirvs:action-participant-type}?; # careteam | device | group |
# healthcareservice | location |
# organization | patient |
# practitioner | practitionerrole |
# relatedperson
fhir:typeCanonical @<Canonical>?; # Who or what can participate
fhir:typeReference @<Reference> AND {fhir:l
@<BiologicallyDerivedProduct> OR
@<CareTeam> OR
@<Device> OR
@<Endpoint> OR
@<HealthcareService> OR
@<Location> OR
@<Medication> OR
@<MedicinalProductDefinition> OR
@<Organization> OR
@<Patient> OR
@<Practitioner> OR
@<PractitionerRole> OR
@<RelatedPerson> OR
@<Specimen> OR
@<Substance> OR
@<SubstanceDefinition> ? }?; # Who or what can participate
fhir:role @<CodeableConcept>?; # E.g. Nurse, Surgeon, Parent, etc
fhir:function @<CodeableConcept>?; # E.g. Author, Reviewer, Witness, etc
}
# Dynamic aspects of the definition
<ActivityDefinition.dynamicValue> EXTENDS @<BackboneElement> CLOSED {
fhir:path @<String>; # The path to the element to be set
# dynamically
fhir:expression @<Expression>; # An expression that provides the
# dynamic value for the
# customization
}
#---------------------- Cardinality Types (OneOrMore) -------------------
<OneOrMore_Identifier> CLOSED {
rdf:first @<Identifier> ;
rdf:rest [rdf:nil] OR @<OneOrMore_Identifier>
}
<OneOrMore_ContactDetail> CLOSED {
rdf:first @<ContactDetail> ;
rdf:rest [rdf:nil] OR @<OneOrMore_ContactDetail>
}
<OneOrMore_UsageContext> CLOSED {
rdf:first @<UsageContext> ;
rdf:rest [rdf:nil] OR @<OneOrMore_UsageContext>
}
<OneOrMore_CodeableConcept> CLOSED {
rdf:first @<CodeableConcept> ;
rdf:rest [rdf:nil] OR @<OneOrMore_CodeableConcept>
}
<OneOrMore_RelatedArtifact> CLOSED {
rdf:first @<RelatedArtifact> ;
rdf:rest [rdf:nil] OR @<OneOrMore_RelatedArtifact>
}
<OneOrMore_Canonical> CLOSED {
rdf:first @<Canonical> ;
rdf:rest [rdf:nil] OR @<OneOrMore_Canonical>
}
<OneOrMore_ActivityDefinition.participant> CLOSED {
rdf:first @<ActivityDefinition.participant> ;
rdf:rest [rdf:nil] OR @<OneOrMore_ActivityDefinition.participant>
}
<OneOrMore_Dosage> CLOSED {
rdf:first @<Dosage> ;
rdf:rest [rdf:nil] OR @<OneOrMore_Dosage>
}
<OneOrMore_ActivityDefinition.dynamicValue> CLOSED {
rdf:first @<ActivityDefinition.dynamicValue> ;
rdf:rest [rdf:nil] OR @<OneOrMore_ActivityDefinition.dynamicValue>
}
#---------------------- Value Sets ------------------------
# The type of participant for the action.
fhirvs:action-participant-type ["careteam" "device" "group" "healthcareservice" "location" "organization" "patient" "practitioner" "practitionerrole" "relatedperson"]
# The lifecycle status of an artifact.
fhirvs:publication-status ["draft" "active" "retired" "unknown"]
# Codes indicating the degree of authority/intentionality associated with a request.
fhirvs:request-intent ["proposal" "solicit-offer" "offer-response" "plan" "directive" "order" "original-order" "reflex-order" "filler-order" "instance-order" "option"]
# Identifies the level of importance to be assigned to actioning the request.
fhirvs:request-priority ["routine" "urgent" "asap" "stat"]
# All Resource Types that represent request resources
fhirvs:request-resource-types ["Appointment" "CarePlan" "Claim" "CommunicationRequest" "CoverageEligibilityRequest" "DeviceRequest" "EnrollmentRequest" "MedicationRequest" "NutritionOrder" "RequestOrchestration" "ServiceRequest" "Task" "VisionPrescription"]
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.