ShEx
statement
for
testscript
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=@<TestScript> AND {fhir:nodeRole [fhir:treeRoot]}
# Describes a set of tests
<TestScript> CLOSED {
a [fhir:TestScript];
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:TestScript.url @<uri>; # Canonical identifier for this test
# script, represented as a URI
# (globally unique)
fhir:TestScript.identifier @<Identifier>?; # Additional identifier for the test
# script
fhir:TestScript.version @<string>?; # Business version of the test script
fhir:TestScript.name @<string>; # Name for this test script
# (computer friendly)
fhir:TestScript.title @<string>?; # Name for this test script (human
# friendly)
fhir:TestScript.status @<code> AND
{fhir:value @fhirvs:publication-status}; # draft | active | retired | unknown
fhir:TestScript.experimental @<boolean>?; # For testing purposes, not real
# usage
fhir:TestScript.date @<dateTime>?; # Date last changed
fhir:TestScript.publisher @<string>?; # Name of the publisher
# (organization or individual)
fhir:TestScript.contact @<ContactDetail>*; # Contact details for the publisher
fhir:TestScript.description @<markdown>?; # Natural language description of
# the test script
fhir:TestScript.useContext @<UsageContext>*; # The context that the content is
# intended to support
fhir:TestScript.jurisdiction @<CodeableConcept>*; # Intended jurisdiction for test
# script (if applicable)
fhir:TestScript.purpose @<markdown>?; # Why this test script is defined
fhir:TestScript.copyright @<markdown>?; # Use and/or publishing restrictions
fhir:TestScript.origin @<TestScript.origin>*; # An abstract server representing a
# client or sender in a message
# exchange
fhir:TestScript.destination @<TestScript.destination>*; # An abstract server representing a
# destination or receiver in a
# message exchange
fhir:TestScript.metadata @<TestScript.metadata>?; # Required capability that is
# assumed to function correctly on
# the FHIR server being tested
fhir:TestScript.fixture @<TestScript.fixture>*; # Fixture in the test script - by
# reference (uri)
fhir:TestScript.profile @<Reference>*; # Reference of the validation profile
fhir:TestScript.variable @<TestScript.variable>*; # Placeholder for evaluated elements
fhir:TestScript.setup @<TestScript.setup>?; # A series of required setup
# operations before tests are
# executed
fhir:TestScript.test @<TestScript.test>*; # A test in this script
fhir:TestScript.teardown @<TestScript.teardown>?; # A series of required clean up steps
fhir:index xsd:integer? # Relative position in a list
}
# Placeholder for evaluated elements
<TestScript.variable> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.variable.name @<string>; # Descriptive name for this variable
fhir:TestScript.variable.defaultValue @<string>?; # Default, hard-coded, or
# user-defined value for this
# variable
fhir:TestScript.variable.description @<string>?; # Natural language description of
# the variable
fhir:TestScript.variable.expression @<string>?; # The FHIRPath expression against
# the fixture body
fhir:TestScript.variable.headerField @<string>?; # HTTP header field name for source
fhir:TestScript.variable.hint @<string>?; # Hint help text for default value
# to enter
fhir:TestScript.variable.path @<string>?; # XPath or JSONPath against the
# fixture body
fhir:TestScript.variable.sourceId @<id>?; # Fixture Id of source expression or
# headerField within this variable
fhir:index xsd:integer? # Relative position in a list
}
# An abstract server representing a destination or receiver in a message exchange
<TestScript.destination> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.destination.index @<integer>; # The index of the abstract
# destination server starting at 1
fhir:TestScript.destination.profile @<Coding>; # FHIR-Server | FHIR-SDC-FormManager
# | FHIR-SDC-FormReceiver |
# FHIR-SDC-FormProcessor
fhir:index xsd:integer? # Relative position in a list
}
# Fixture in the test script - by reference (uri)
<TestScript.fixture> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.fixture.autocreate @<boolean>; # Whether or not to implicitly
# create the fixture during setup
fhir:TestScript.fixture.autodelete @<boolean>; # Whether or not to implicitly
# delete the fixture during teardown
fhir:TestScript.fixture.resource @<Reference>?; # Reference of the resource
fhir:index xsd:integer? # Relative position in a list
}
# Required capability that is assumed to function correctly on the FHIR server being tested
<TestScript.metadata> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.metadata.link @<TestScript.metadata.link>*; # Links to the FHIR specification
fhir:TestScript.metadata.capability @<TestScript.metadata.capability>+; # Capabilities that are assumed to
# function correctly on the FHIR
# server being tested
fhir:index xsd:integer? # Relative position in a list
}
# An abstract server representing a client or sender in a message exchange
<TestScript.origin> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.origin.index @<integer>; # The index of the abstract origin
# server starting at 1
fhir:TestScript.origin.profile @<Coding>; # FHIR-Client | FHIR-SDC-FormFiller
fhir:index xsd:integer? # Relative position in a list
}
# A series of required clean up steps
<TestScript.teardown> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.teardown.action @<TestScript.teardown.action>+; # One or more teardown operations to
# perform
fhir:index xsd:integer? # Relative position in a list
}
# A test in this script
<TestScript.test> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.test.name @<string>?; # Tracking/logging name of this test
fhir:TestScript.test.description @<string>?; # Tracking/reporting short
# description of the test
fhir:TestScript.test.action @<TestScript.test.action>+; # A test operation or assert to
# perform
fhir:index xsd:integer? # Relative position in a list
}
# A series of required setup operations before tests are executed
<TestScript.setup> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.setup.action @<TestScript.setup.action>+; # A setup operation or assert to
# perform
fhir:index xsd:integer? # Relative position in a list
}
# A setup operation or assert to perform
<TestScript.setup.action> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.setup.action.operation @<TestScript.setup.action.operation>?; # The setup operation to perform
fhir:TestScript.setup.action.assert @<TestScript.setup.action.assert>?; # The assertion to perform
fhir:index xsd:integer? # Relative position in a list
}
# Capabilities that are assumed to function correctly on the FHIR server being tested
<TestScript.metadata.capability> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.metadata.capability.required @<boolean>; # Are the capabilities required?
fhir:TestScript.metadata.capability.validated @<boolean>; # Are the capabilities validated?
fhir:TestScript.metadata.capability.description @<string>?; # The expected capabilities of the
# server
fhir:TestScript.metadata.capability.origin @<integer>*; # Which origin server these
# requirements apply to
fhir:TestScript.metadata.capability.destination @<integer>?; # Which server these requirements
# apply to
fhir:TestScript.metadata.capability.link @<uri>*; # Links to the FHIR specification
fhir:TestScript.metadata.capability.capabilities @<canonical>; # Required Capability Statement
fhir:index xsd:integer? # Relative position in a list
}
# Links to the FHIR specification
<TestScript.metadata.link> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.metadata.link.url @<uri>; # URL to the specification
fhir:TestScript.metadata.link.description @<string>?; # Short description
fhir:index xsd:integer? # Relative position in a list
}
# A test operation or assert to perform
<TestScript.test.action> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.test.action.operation @<TestScript.test.action.operation>?; # The setup operation to perform
fhir:TestScript.test.action.assert @<TestScript.test.action.assert>?; # The setup assertion to perform
fhir:index xsd:integer? # Relative position in a list
}
# One or more teardown operations to perform
<TestScript.teardown.action> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.teardown.action.operation @<TestScript.teardown.action.operation>; # The teardown operation to perform
fhir:index xsd:integer? # Relative position in a list
}
# The teardown operation to perform
<TestScript.teardown.action.operation> CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
# The assertion to perform
<TestScript.setup.action.assert> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.setup.action.assert.label @<string>?; # Tracking/logging assertion label
fhir:TestScript.setup.action.assert.description @<string>?; # Tracking/reporting assertion
# description
fhir:TestScript.setup.action.assert.direction @<code> AND
{fhir:value @fhirvs:assert-direction-codes}?; # response | request
fhir:TestScript.setup.action.assert.compareToSourceId @<string>?; # Id of the source fixture to be
# evaluated
fhir:TestScript.setup.action.assert.compareToSourceExpression @<string>?; # The FHIRPath expression to
# evaluate against the source
# fixture
fhir:TestScript.setup.action.assert.compareToSourcePath @<string>?; # XPath or JSONPath expression to
# evaluate against the source
# fixture
fhir:TestScript.setup.action.assert.contentType @<code> AND
{fhir:value @fhirvs:mimetypes}?; # Mime type to compare against the
# 'Content-Type' header
fhir:TestScript.setup.action.assert.expression @<string>?; # The FHIRPath expression to be
# evaluated
fhir:TestScript.setup.action.assert.headerField @<string>?; # HTTP header field name
fhir:TestScript.setup.action.assert.minimumId @<string>?; # Fixture Id of minimum content
# resource
fhir:TestScript.setup.action.assert.navigationLinks @<boolean>?; # Perform validation on navigation
# links?
fhir:TestScript.setup.action.assert.operator @<code> AND
{fhir:value @fhirvs:assert-operator-codes}?; # equals | notEquals | in | notIn |
# greaterThan | lessThan | empty |
# notEmpty | contains | notContains
# | eval
fhir:TestScript.setup.action.assert.path @<string>?; # XPath or JSONPath expression
fhir:TestScript.setup.action.assert.requestMethod @<code> AND
{fhir:value @fhirvs:http-operations}?; # delete | get | options | patch |
# post | put | head
fhir:TestScript.setup.action.assert.requestURL @<string>?; # Request URL comparison value
fhir:TestScript.setup.action.assert.resource @<code> AND
{fhir:value @fhirvs:defined-types}?; # Resource type
fhir:TestScript.setup.action.assert.response @<code> AND
{fhir:value @fhirvs:assert-response-code-types}?; # okay | created | noContent |
# notModified | bad | forbidden |
# notFound | methodNotAllowed |
# conflict | gone |
# preconditionFailed | unprocessable
fhir:TestScript.setup.action.assert.responseCode @<string>?; # HTTP response code to test
fhir:TestScript.setup.action.assert.sourceId @<id>?; # Fixture Id of source expression or
# headerField
fhir:TestScript.setup.action.assert.validateProfileId @<id>?; # Profile Id of validation profile
# reference
fhir:TestScript.setup.action.assert.value @<string>?; # The value to compare to
fhir:TestScript.setup.action.assert.warningOnly @<boolean>; # Will this assert produce a warning
# only on error?
fhir:index xsd:integer? # Relative position in a list
}
# The setup operation to perform
<TestScript.setup.action.operation> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.setup.action.operation.type @<Coding>?; # The operation code type that will
# be executed
fhir:TestScript.setup.action.operation.resource @<code> AND
{fhir:value @fhirvs:defined-types}?; # Resource type
fhir:TestScript.setup.action.operation.label @<string>?; # Tracking/logging operation label
fhir:TestScript.setup.action.operation.description @<string>?; # Tracking/reporting operation
# description
fhir:TestScript.setup.action.operation.accept @<code> AND
{fhir:value @fhirvs:mimetypes}?; # Mime type to accept in the payload
# of the response, with charset etc.
fhir:TestScript.setup.action.operation.contentType @<code> AND
{fhir:value @fhirvs:mimetypes}?; # Mime type of the request payload
# contents, with charset etc.
fhir:TestScript.setup.action.operation.destination @<integer>?; # Server responding to the request
fhir:TestScript.setup.action.operation.encodeRequestUrl @<boolean>; # Whether or not to send the request
# url in encoded format
fhir:TestScript.setup.action.operation.method @<code> AND
{fhir:value @fhirvs:http-operations}?; # delete | get | options | patch |
# post | put | head
fhir:TestScript.setup.action.operation.origin @<integer>?; # Server initiating the request
fhir:TestScript.setup.action.operation.params @<string>?; # Explicitly defined path parameters
fhir:TestScript.setup.action.operation.requestHeader @<TestScript.setup.action.operation.requestHeader>*; # Each operation can have one or
# more header elements
fhir:TestScript.setup.action.operation.requestId @<id>?; # Fixture Id of mapped request
fhir:TestScript.setup.action.operation.responseId @<id>?; # Fixture Id of mapped response
fhir:TestScript.setup.action.operation.sourceId @<id>?; # Fixture Id of body for PUT and
# POST requests
fhir:TestScript.setup.action.operation.targetId @<id>?; # Id of fixture used for extracting
# the [id], [type], and [vid] for
# GET requests
fhir:TestScript.setup.action.operation.url @<string>?; # Request URL
fhir:index xsd:integer? # Relative position in a list
}
# The setup operation to perform
<TestScript.test.action.operation> CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
# The setup assertion to perform
<TestScript.test.action.assert> CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
# Each operation can have one or more header elements
<TestScript.setup.action.operation.requestHeader> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
fhir:TestScript.setup.action.operation.requestHeader.field @<string>; # HTTP header field name
fhir:TestScript.setup.action.operation.requestHeader.value @<string>; # HTTP headerfield value
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 dateTime?; # Primitive value for dateTime
fhir:index xsd:integer? # Relative position in a list
}
# Metadata about a resource
<Meta> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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.source @<uri>?; # Identifies where the resource
# comes from
fhir:Meta.profile @<canonical>*; # 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 code?; # 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 string MAXLENGTH 1048576?; # Primitive value for string
fhir:index xsd:integer? # Relative position in a list
}
# A reference from one resource to another
<Reference> CLOSED {
fhir:link IRI?;
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:Reference.reference @<string>?; # Literal reference, Relative,
# internal or absolute URL
fhir:Reference.type @<uri>?; # Type the reference refers to (e.g.
# "Patient")
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?
}
# 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 integer MININCLUSIVE -2147483648 MAXINCLUSIVE 2147483647?; # Primitive value for integer
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type canonical
<canonical> CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:value canonical?; # Primitive value for canonical
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 uri?; # Primitive value for uri
fhir:index xsd:integer? # Relative position in a list
}
# Optional Extensions Element
<Extension> CLOSED {
fhir:Element.id id?;
fhir:Element.extension @<Extension>*;
fhir:Extension.url uri;
(
fhir:Extension.valueBase64Binary @<base64Binary> |
fhir:Extension.valueBoolean @<boolean> |
fhir:Extension.valueCanonical @<canonical> |
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.valueUrl @<url> |
fhir:Extension.valueUuid @<uuid> |
fhir:Extension.valueAddress @<Address> |
fhir:Extension.valueAge @<Age> |
fhir:Extension.valueAnnotation @<Annotation> |
fhir:Extension.valueAttachment @<Attachment> |
fhir:Extension.valueCodeableConcept @<CodeableConcept> |
fhir:Extension.valueCodeableReference @<CodeableReference> |
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.valueRatioRange @<RatioRange> |
fhir:Extension.valueReference @<Reference> |
fhir:Extension.valueSampledData @<SampledData> |
fhir:Extension.valueSignature @<Signature> |
fhir:Extension.valueTiming @<Timing> |
fhir:Extension.valueContactDetail @<ContactDetail> |
fhir:Extension.valueContributor @<Contributor> |
fhir:Extension.valueDataRequirement @<DataRequirement> |
fhir:Extension.valueExpression @<Expression> |
fhir:Extension.valueParameterDefinition @<ParameterDefinition> |
fhir:Extension.valueRelatedArtifact @<RelatedArtifact> |
fhir:Extension.valueTriggerDefinition @<TriggerDefinition> |
fhir:Extension.valueUsageContext @<UsageContext> |
fhir:Extension.valueDosage @<Dosage>
)?;
fhir:index xsd:integer? # Relative position in a list
}
# Contact information
<ContactDetail> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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
}
# An identifier intended for computation
<Identifier> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:Identifier.use @<code> AND
{fhir:value @fhirvs:identifier-use}?; # usual | official | temp |
# secondary | old (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
}
# 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 boolean?; # Primitive value for boolean
fhir:index xsd:integer? # Relative position in a list
}
# Human-readable summary of the resource (essential clinical and business information)
<Narrative> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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
}
# Describes the context of use for a conformance or knowledge resource
<UsageContext> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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:UsageContext.valueReference @<Reference>
);
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 id?; # Unique id for inter-element
# referencing
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 markdown?; # 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 id?; # Primitive value for id
fhir:index xsd:integer? # Relative position in a list
}
# Concept - reference to a terminology or just text
<CodeableConcept> CLOSED {
a NONLITERAL*;
fhir:Element.id id?; # Unique id for inter-element
# referencing
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
}
# 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 date?; # Primitive value for date
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 id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:Address.use @<code> AND
{fhir:value @fhirvs:address-use}?; # home | work | temp | old | billing
# - 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 id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:Attachment.contentType @<code> AND
{fhir:value @fhirvs:mimetypes}?; # 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 @<url>?; # 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
}
# A measured or measurable amount
<Count> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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
}
# Describes a required data item
<DataRequirement> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:DataRequirement.type @<code> AND
{fhir:value @fhirvs:all-types}; # The type of the required data
fhir:DataRequirement.profile @<canonical>*; # The profile of the required data
( # E.g. Patient, Practitioner,
# RelatedPerson, Organization,
# Location, Device
fhir:DataRequirement.subjectCodeableConcept @<CodeableConcept> |
fhir:DataRequirement.subjectReference @<Reference>
)?;
fhir:DataRequirement.mustSupport @<string>*; # Indicates specific structure
# elements that are referenced by
# the knowledge module
fhir:DataRequirement.codeFilter @<DataRequirement.codeFilter>*; # What codes are expected
fhir:DataRequirement.dateFilter @<DataRequirement.dateFilter>*; # What dates/date ranges are expected
fhir:DataRequirement.limit @<positiveInt>?; # Number of results
fhir:DataRequirement.sort @<DataRequirement.sort>*; # Order of the results
fhir:index xsd:integer? # Relative position in a list
}
# How the medication is/was taken or should be taken
<Dosage> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
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 or
# warnings to the patient - e.g.
# "with meals", "may cause
# drowsiness"
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
fhir:Dosage.doseAndRate @<Dosage.doseAndRate>*; # Amount of medication administered
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
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type uuid
<uuid> CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:value uuid?; # Primitive value for uuid
fhir:index xsd:integer? # Relative position in a list
}
# Range of ratio values
<RatioRange> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:RatioRange.lowNumerator @<SimpleQuantity>?; # Low Numerator limit
fhir:RatioRange.highNumerator @<SimpleQuantity>?; # High Numerator limit
fhir:RatioRange.denominator @<SimpleQuantity>?; # Denominator value
fhir:index xsd:integer? # Relative position in a list
}
# A series of measurements taken by a device
<SampledData> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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
}
# 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 positiveInt?; # Primitive value for positiveInt
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 id?; # Unique id for inter-element
# referencing
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
}
# Time range defined by start and end date/time
<Period> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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 length of time
<Duration> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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 id?; # Unique id for inter-element
# referencing
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
}
# Related artifacts for a knowledge resource
<RelatedArtifact> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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.label @<string>?; # Short label
fhir:RelatedArtifact.display @<string>?; # Brief description of the related
# artifact
fhir:RelatedArtifact.citation @<markdown>?; # Bibliographic citation for the
# artifact
fhir:RelatedArtifact.url @<url>?; # Where the artifact can be accessed
fhir:RelatedArtifact.document @<Attachment>?; # What document is being referenced
fhir:RelatedArtifact.resource @<canonical>?; # What resource is being referenced
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 base64Binary?; # Primitive value for base64Binary
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 id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @<Extension>*; # Extensions that cannot be ignored
# even if unrecognized
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 | +
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 decimal?; # Primitive value for decimal
fhir:index xsd:integer? # Relative position in a list
}
# Definition of a parameter to a module
<ParameterDefinition> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:ParameterDefinition.name @<code>?; # Name used to access the parameter
# value
fhir:ParameterDefinition.use @<code> AND
{fhir:value @fhirvs:operation-parameter-use}; # in | out
fhir:ParameterDefinition.min @<integer>?; # Minimum cardinality
fhir:ParameterDefinition.max @<string>?; # Maximum cardinality (a number of *)
fhir:ParameterDefinition.documentation @<string>?; # A brief description of the
# parameter
fhir:ParameterDefinition.type @<code> AND
{fhir:value @fhirvs:all-types}; # What type of value
fhir:ParameterDefinition.profile @<canonical>?; # What profile the value is expected
# to be
fhir:index xsd:integer? # Relative position in a list
}
# Contributor information
<Contributor> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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
}
# 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 oid?; # Primitive value for oid
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 instant?; # 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 id?; # Unique id for inter-element
# referencing
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 id?; # Unique id for inter-element
# referencing
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 id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:Money.value @<decimal>?; # Numerical value (with implicit
# precision)
fhir:Money.currency @<code> AND
{fhir:value @fhirvs:currencies}?; # ISO 4217 Currency Code
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 id?; # Unique id for inter-element
# referencing
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
}
# A duration of time during which an organism (or a process) has existed
<Age> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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
}
# Defines an expected trigger for a module
<TriggerDefinition> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:TriggerDefinition.type @<code> AND
{fhir:value @fhirvs:trigger-type}; # named-event | periodic |
# data-changed | data-added |
# data-modified | data-removed |
# data-accessed | data-access-ended
fhir:TriggerDefinition.name @<string>?; # Name or URI that identifies the
# event
( # Timing of the event
fhir:TriggerDefinition.timingTiming @<Timing> |
fhir:TriggerDefinition.timingReference @<Reference> |
fhir:TriggerDefinition.timingDate @<date> |
fhir:TriggerDefinition.timingDateTime @<dateTime>
)?;
fhir:TriggerDefinition.data @<DataRequirement>*; # Triggering data of the event
# (multiple = 'and')
fhir:TriggerDefinition.condition @<Expression>?; # Whether the event triggers
# (boolean expression)
fhir:index xsd:integer? # Relative position in a list
}
# A measured or measurable amount
<Quantity> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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 url
<url> CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:value url?; # Primitive value for url
fhir:index xsd:integer? # Relative position in a list
}
# Text node with attribution
<Annotation> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
( # Individual responsible for the
# annotation
fhir:Annotation.authorReference @<Reference> |
fhir:Annotation.authorString @<string>
)?;
fhir:Annotation.time @<dateTime>?; # When the annotation was made
fhir:Annotation.text @<markdown>; # The annotation - text content (as
# markdown)
fhir:index xsd:integer? # Relative position in a list
}
# An expression that can be used to generate a value
<Expression> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:Expression.description @<string>?; # Natural language description of
# the condition
fhir:Expression.name @<id>?; # Short name assigned to expression
# for reuse
fhir:Expression.language @<code>; # text/cql | text/fhirpath |
# application/x-fhir-query |
# text/cql-identifier |
# text/cql-expression | etc.
fhir:Expression.expression @<string>?; # Expression in specified language
fhir:Expression.reference @<uri>?; # Where the expression is found
fhir:index xsd:integer? # Relative position in a list
}
# Reference to a resource or a concept
<CodeableReference> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:CodeableReference.concept @<CodeableConcept>?; # Reference to a concept (by class)
fhir:CodeableReference.reference @<Reference>?; # Reference to a resource (by
# instance)
fhir:index xsd:integer? # Relative position in a list
}
# A Signature - XML DigSig, JWS, Graphical image of signature, etc.
<Signature> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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
fhir:Signature.who @<Reference>; # Who signed
fhir:Signature.onBehalfOf @<Reference>?; # The party represented
fhir:Signature.targetFormat @<code> AND
{fhir:value @fhirvs:mimetypes}?; # The technical format of the signed
# resources
fhir:Signature.sigFormat @<code> AND
{fhir:value @fhirvs:mimetypes}?; # The technical format of the
# signature
fhir:Signature.data @<base64Binary>?; # The actual signature content (XML
# DigSig. JWS, 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 unsignedInt?; # 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 time?; # Primitive value for time
fhir:index xsd:integer? # Relative position in a list
}
# A fixed quantity (no comparator)
<SimpleQuantity> CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
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
}
# What dates/date ranges are expected
<DataRequirement.dateFilter> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:DataRequirement.dateFilter.path @<string>?; # A date-valued attribute to filter
# on
fhir:DataRequirement.dateFilter.searchParam @<string>?; # A date valued parameter to search
# on
( # The value of the filter, as a
# Period, DateTime, or Duration
# value
fhir:DataRequirement.dateFilter.valueDateTime @<dateTime> |
fhir:DataRequirement.dateFilter.valuePeriod @<Period> |
fhir:DataRequirement.dateFilter.valueDuration @<Duration>
)?;
fhir:index xsd:integer? # Relative position in a list
}
# What codes are expected
<DataRequirement.codeFilter> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:DataRequirement.codeFilter.path @<string>?; # A code-valued attribute to filter
# on
fhir:DataRequirement.codeFilter.searchParam @<string>?; # A coded (token) parameter to
# search on
fhir:DataRequirement.codeFilter.valueSet @<canonical>?; # Valueset for the filter
fhir:DataRequirement.codeFilter.code @<Coding>*; # What code is expected
fhir:index xsd:integer? # Relative position in a list
}
# Amount of medication administered
<Dosage.doseAndRate> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:Dosage.doseAndRate.type @<CodeableConcept>?; # The kind of dose or rate specified
( # Amount of medication per dose
fhir:Dosage.doseAndRate.doseRange @<Range> |
fhir:Dosage.doseAndRate.doseQuantity @<SimpleQuantity>
)?;
( # Amount of medication per unit of
# time
fhir:Dosage.doseAndRate.rateRatio @<Ratio> |
fhir:Dosage.doseAndRate.rateRange @<Range> |
fhir:Dosage.doseAndRate.rateQuantity @<SimpleQuantity>
)?;
fhir:index xsd:integer? # Relative position in a list
}
# When the event is to occur
<Timing.repeat> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
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 @<positiveInt>?; # Number of times to repeat
fhir:Timing.repeat.countMax @<positiveInt>?; # 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 @<positiveInt>?; # Event occurs frequency times per
# period
fhir:Timing.repeat.frequencyMax @<positiveInt>?; # 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}*; # Code for time period of occurrence
fhir:Timing.repeat.offset @<unsignedInt>?; # Minutes from event (before or
# after)
fhir:index xsd:integer? # Relative position in a list
}
# Order of the results
<DataRequirement.sort> CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @<Extension>*; # Additional content defined by
# implementations
fhir:DataRequirement.sort.path @<string>; # The name of the attribute to
# perform the sort
fhir:DataRequirement.sort.direction @<code> AND
{fhir:value @fhirvs:sort-direction}; # ascending | descending
fhir:index xsd:integer? # Relative position in a list
}
#---------------------- Reference Types -------------------
#---------------------- Value Sets ------------------------
# The type of an address (physical / postal).
fhirvs:address-type ["postal" "physical" "both"]
# The type of trigger.
fhirvs:trigger-type ["named-event" "periodic" "data-changed" "data-added" "data-modified" "data-removed" "data-accessed" "data-access-ended"]
# Telecommunications form for contact point.
fhirvs:contact-point-system ["phone" "fax" "email" "pager" "url" "sms" "other"]
# A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.
fhirvs:defined-types ["Address" "Age" "Annotation" "Attachment" "BackboneElement" "CodeableConcept" "CodeableReference" "Coding" "ContactDetail" "ContactPoint" "Contributor" "Count" "DataRequirement" "Distance" "Dosage" "Duration" "Element" "ElementDefinition" "Expression" "Extension" "HumanName" "Identifier" "MarketingStatus" "Meta" "Money" "MoneyQuantity" "Narrative" "ParameterDefinition" "Period" "Population" "ProdCharacteristic" "ProductShelfLife" "Quantity" "Range" "Ratio" "RatioRange" "Reference" "RelatedArtifact" "SampledData" "Signature" "SimpleQuantity" "Timing" "TriggerDefinition" "UsageContext" "base64Binary" "boolean" "canonical" "code" "date" "dateTime" "decimal" "id" "instant" "integer" "markdown" "oid" "positiveInt" "string" "time" "unsignedInt" "uri" "url" "uuid" "xhtml" "Resource" "Binary" "Bundle" "DomainResource" "Account" "ActivityDefinition" "AdministrableProductDefinition" "AdverseEvent" "AllergyIntolerance" "Appointment" "AppointmentResponse" "AuditEvent" "Basic" "BiologicallyDerivedProduct" "BodyStructure" "CapabilityStatement" "CarePlan" "CareTeam" "CatalogEntry" "ChargeItem" "ChargeItemDefinition" "Citation" "Claim" "ClaimResponse" "ClinicalImpression" "ClinicalUseDefinition" "CodeSystem" "Communication" "CommunicationRequest" "CompartmentDefinition" "Composition" "ConceptMap" "Condition" "Consent" "Contract" "Coverage" "CoverageEligibilityRequest" "CoverageEligibilityResponse" "DetectedIssue" "Device" "DeviceDefinition" "DeviceMetric" "DeviceRequest" "DeviceUseStatement" "DiagnosticReport" "DocumentManifest" "DocumentReference" "Encounter" "Endpoint" "EnrollmentRequest" "EnrollmentResponse" "EpisodeOfCare" "EventDefinition" "Evidence" "EvidenceReport" "EvidenceVariable" "ExampleScenario" "ExplanationOfBenefit" "FamilyMemberHistory" "Flag" "Goal" "GraphDefinition" "Group" "GuidanceResponse" "HealthcareService" "ImagingStudy" "Immunization" "ImmunizationEvaluation" "ImmunizationRecommendation" "ImplementationGuide" "Ingredient" "InsurancePlan" "Invoice" "Library" "Linkage" "List" "Location" "ManufacturedItemDefinition" "Measure" "MeasureReport" "Media" "Medication" "MedicationAdministration" "MedicationDispense" "MedicationKnowledge" "MedicationRequest" "MedicationStatement" "MedicinalProductDefinition" "MessageDefinition" "MessageHeader" "MolecularSequence" "NamingSystem" "NutritionOrder" "NutritionProduct" "Observation" "ObservationDefinition" "OperationDefinition" "OperationOutcome" "Organization" "OrganizationAffiliation" "PackagedProductDefinition" "Patient" "PaymentNotice" "PaymentReconciliation" "Person" "PlanDefinition" "Practitioner" "PractitionerRole" "Procedure" "Provenance" "Questionnaire" "QuestionnaireResponse" "RegulatedAuthorization" "RelatedPerson" "RequestGroup" "ResearchDefinition" "ResearchElementDefinition" "ResearchStudy" "ResearchSubject" "RiskAssessment" "Schedule" "SearchParameter" "ServiceRequest" "Slot" "Specimen" "SpecimenDefinition" "StructureDefinition" "StructureMap" "Subscription" "SubscriptionStatus" "SubscriptionTopic" "Substance" "SubstanceDefinition" "SupplyDelivery" "SupplyRequest" "Task" "TerminologyCapabilities" "TestReport" "TestScript" "ValueSet" "VerificationResult" "VisionPrescription" "Parameters"]
# The days of the week.
fhirvs:days-of-week ["mon" "tue" "wed" "thu" "fri" "sat" "sun"]
# The type of relationship to the related artifact.
fhirvs:related-artifact-type ["documentation" "justification" "citation" "predecessor" "successor" "derived-from" "depends-on" "composed-of"]
# The lifecycle status of an artifact.
fhirvs:publication-status ["draft" "active" "retired" "unknown"]
# A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
fhirvs:all-types ["Address" "Age" "Annotation" "Attachment" "BackboneElement" "CodeableConcept" "CodeableReference" "Coding" "ContactDetail" "ContactPoint" "Contributor" "Count" "DataRequirement" "Distance" "Dosage" "Duration" "Element" "ElementDefinition" "Expression" "Extension" "HumanName" "Identifier" "MarketingStatus" "Meta" "Money" "MoneyQuantity" "Narrative" "ParameterDefinition" "Period" "Population" "ProdCharacteristic" "ProductShelfLife" "Quantity" "Range" "Ratio" "RatioRange" "Reference" "RelatedArtifact" "SampledData" "Signature" "SimpleQuantity" "Timing" "TriggerDefinition" "UsageContext" "base64Binary" "boolean" "canonical" "code" "date" "dateTime" "decimal" "id" "instant" "integer" "markdown" "oid" "positiveInt" "string" "time" "unsignedInt" "uri" "url" "uuid" "xhtml" "Resource" "Binary" "Bundle" "DomainResource" "Account" "ActivityDefinition" "AdministrableProductDefinition" "AdverseEvent" "AllergyIntolerance" "Appointment" "AppointmentResponse" "AuditEvent" "Basic" "BiologicallyDerivedProduct" "BodyStructure" "CapabilityStatement" "CarePlan" "CareTeam" "CatalogEntry" "ChargeItem" "ChargeItemDefinition" "Citation" "Claim" "ClaimResponse" "ClinicalImpression" "ClinicalUseDefinition" "CodeSystem" "Communication" "CommunicationRequest" "CompartmentDefinition" "Composition" "ConceptMap" "Condition" "Consent" "Contract" "Coverage" "CoverageEligibilityRequest" "CoverageEligibilityResponse" "DetectedIssue" "Device" "DeviceDefinition" "DeviceMetric" "DeviceRequest" "DeviceUseStatement" "DiagnosticReport" "DocumentManifest" "DocumentReference" "Encounter" "Endpoint" "EnrollmentRequest" "EnrollmentResponse" "EpisodeOfCare" "EventDefinition" "Evidence" "EvidenceReport" "EvidenceVariable" "ExampleScenario" "ExplanationOfBenefit" "FamilyMemberHistory" "Flag" "Goal" "GraphDefinition" "Group" "GuidanceResponse" "HealthcareService" "ImagingStudy" "Immunization" "ImmunizationEvaluation" "ImmunizationRecommendation" "ImplementationGuide" "Ingredient" "InsurancePlan" "Invoice" "Library" "Linkage" "List" "Location" "ManufacturedItemDefinition" "Measure" "MeasureReport" "Media" "Medication" "MedicationAdministration" "MedicationDispense" "MedicationKnowledge" "MedicationRequest" "MedicationStatement" "MedicinalProductDefinition" "MessageDefinition" "MessageHeader" "MolecularSequence" "NamingSystem" "NutritionOrder" "NutritionProduct" "Observation" "ObservationDefinition" "OperationDefinition" "OperationOutcome" "Organization" "OrganizationAffiliation" "PackagedProductDefinition" "Patient" "PaymentNotice" "PaymentReconciliation" "Person" "PlanDefinition" "Practitioner" "PractitionerRole" "Procedure" "Provenance" "Questionnaire" "QuestionnaireResponse" "RegulatedAuthorization" "RelatedPerson" "RequestGroup" "ResearchDefinition" "ResearchElementDefinition" "ResearchStudy" "ResearchSubject" "RiskAssessment" "Schedule" "SearchParameter" "ServiceRequest" "Slot" "Specimen" "SpecimenDefinition" "StructureDefinition" "StructureMap" "Subscription" "SubscriptionStatus" "SubscriptionTopic" "Substance" "SubstanceDefinition" "SupplyDelivery" "SupplyRequest" "Task" "TerminologyCapabilities" "TestReport" "TestScript" "ValueSet" "VerificationResult" "VisionPrescription" "Parameters" "Type" "Any"]
# Use of contact point.
fhirvs:contact-point-use ["home" "work" "temp" "old" "mobile"]
# Currency codes from ISO 4217 (see https://www.iso.org/iso-4217-currency-codes.html)
fhirvs:currencies ["AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TVD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"]
# This value set includes all possible codes from BCP-13 (http://tools.ietf.org/html/bcp13)
fhirvs:mimetypes EXTERNAL
# The type of operator to use for assertion.
fhirvs:assert-operator-codes ["equals" "notEquals" "in" "notIn" "greaterThan" "lessThan" "empty" "notEmpty" "contains" "notContains" "eval"]
# A unit of time (units from UCUM).
fhirvs:units-of-time ["s" "min" "h" "d" "wk" "mo" "a"]
# The type of contributor.
fhirvs:contributor-type ["author" "editor" "reviewer" "endorser"]
# The type of direction to use for assertion.
fhirvs:assert-direction-codes ["response" "request"]
# The allowable request method or HTTP operation codes.
fhirvs:http-operations ["delete" "get" "options" "patch" "post" "put" "head"]
# The status of a resource narrative.
fhirvs:narrative-status ["generated" "extensions" "additional" "empty"]
# The use of a human name.
fhirvs:name-use ["usual" "official" "temp" "nickname" "anonymous" "old" "maiden"]
# Identifies the purpose for this identifier, if known .
fhirvs:identifier-use ["usual" "official" "temp" "secondary" "old"]
# Whether an operation parameter is an input or an output parameter.
fhirvs:operation-parameter-use ["in" "out"]
# The type of response code to use for assertion.
fhirvs:assert-response-code-types ["okay" "created" "noContent" "notModified" "bad" "forbidden" "notFound" "methodNotAllowed" "conflict" "gone" "preconditionFailed" "unprocessable"]
# The use of an address.
fhirvs:address-use ["home" "work" "temp" "old" "billing"]
# Real world event relating to the schedule.
fhirvs:event-timing ["MORN" "MORN.early" "MORN.late" "NOON" "AFT" "AFT.early" "AFT.late" "EVE" "EVE.early" "EVE.late" "NIGHT" "PHS" "HS" "WAKE" "C" "CM" "CD" "CV" "AC" "ACM" "ACD" "ACV" "PC" "PCM" "PCD" "PCV"]
# How the Quantity should be understood and represented.
fhirvs:quantity-comparator ["<" "<=" ">=" ">"]
# The possible sort directions, ascending or descending.
fhirvs:sort-direction ["ascending" "descending"]
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#>
IMPORT <id.shex>
IMPORT <uri.shex>
IMPORT <url.shex>
IMPORT <code.shex>
IMPORT <string.shex>
IMPORT <Coding.shex>
IMPORT <boolean.shex>
IMPORT <integer.shex>
IMPORT <dateTime.shex>
IMPORT <markdown.shex>
IMPORT <Resource.shex>
IMPORT <canonical.shex>
IMPORT <Reference.shex>
IMPORT <Identifier.shex>
IMPORT <UsageContext.shex>
IMPORT <Requirements.shex>
IMPORT <ContactDetail.shex>
IMPORT <DomainResource.shex>
IMPORT <CodeableConcept.shex>
IMPORT <BackboneElement.shex>
start=@<TestScript> AND {fhir:nodeRole [fhir:treeRoot]}
# Describes a set of tests
<TestScript> EXTENDS @<DomainResource> CLOSED {
a [fhir:TestScript]?;
fhir:nodeRole [fhir:treeRoot]?;
fhir:url @<uri>?; # Canonical identifier for this test
# script, represented as a URI
# (globally unique)
fhir:identifier @<OneOrMore_Identifier>?; # Additional identifier for the test
# script
fhir:version @<string>?; # Business version of the test script
fhir:versionAlgorithm @<string> OR
@<Coding> ?; # How to compare versions
fhir:name @<string>; # Name for this test script
# (computer friendly)
fhir:title @<string>?; # Name for this test script (human
# friendly)
fhir:status @<code> AND
{fhir:v @fhirvs:publication-status}; # draft | active | retired | unknown
fhir:experimental @<boolean>?; # For testing purposes, not real
# usage
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 test script
fhir:useContext @<OneOrMore_UsageContext>?; # The context that the content is
# intended to support
fhir:jurisdiction @<OneOrMore_CodeableConcept>?; # Intended jurisdiction for test
# script (if applicable)
fhir:purpose @<markdown>?; # Why this test script is defined
fhir:copyright @<markdown>?; # Use and/or publishing restrictions
fhir:copyrightLabel @<string>?; # Copyright holder and year(s)
fhir:origin @<OneOrMore_TestScript.origin>?; # An abstract server representing a
# client or sender in a message
# exchange
fhir:destination @<OneOrMore_TestScript.destination>?; # An abstract server representing a
# destination or receiver in a
# message exchange
fhir:metadata @<TestScript.metadata>?; # Required capability that is
# assumed to function correctly on
# the FHIR server being tested
fhir:scope @<OneOrMore_TestScript.scope>?; # Indication of the artifact(s) that
# are tested by this test case
fhir:fixture @<OneOrMore_TestScript.fixture>?; # Fixture in the test script - by
# reference (uri)
fhir:profile @<OneOrMore_canonical>?; # Reference of the validation profile
fhir:variable @<OneOrMore_TestScript.variable>?; # Placeholder for evaluated elements
fhir:setup @<TestScript.setup>?; # A series of required setup
# operations before tests are
# executed
fhir:test @<OneOrMore_TestScript.test>?; # A test in this script
fhir:teardown @<TestScript.teardown>?; # A series of required clean up steps
}
# A series of required clean up steps
<TestScript.teardown> EXTENDS @<BackboneElement> CLOSED {
fhir:action @<OneOrMore_TestScript.teardown.action>; # One or more teardown operations to
# perform
}
# Required capability that is assumed to function correctly on the FHIR server being tested
<TestScript.metadata> EXTENDS @<BackboneElement> CLOSED {
fhir:link @<OneOrMore_TestScript.metadata.link>?; # Links to the FHIR specification
fhir:capability @<OneOrMore_TestScript.metadata.capability>; # Capabilities that are assumed to
# function correctly on the FHIR
# server being tested
}
# Placeholder for evaluated elements
<TestScript.variable> EXTENDS @<BackboneElement> CLOSED {
fhir:name @<string>; # Descriptive name for this variable
fhir:defaultValue @<string>?; # Default, hard-coded, or
# user-defined value for this
# variable
fhir:description @<string>?; # Natural language description of
# the variable
fhir:expression @<string>?; # The FHIRPath expression against
# the fixture body
fhir:headerField @<string>?; # HTTP header field name for source
fhir:hint @<string>?; # Hint help text for default value
# to enter
fhir:path @<string>?; # XPath or JSONPath against the
# fixture body
fhir:sourceId @<id>?; # Fixture Id of source expression or
# headerField within this variable
}
# Capabilities that are assumed to function correctly on the FHIR server being tested
<TestScript.metadata.capability> EXTENDS @<BackboneElement> CLOSED {
fhir:required @<boolean>; # Are the capabilities required?
fhir:validated @<boolean>; # Are the capabilities validated?
fhir:description @<string>?; # The expected capabilities of the
# server
fhir:origin @<OneOrMore_integer>?; # Which origin server these
# requirements apply to
fhir:destination @<integer>?; # Which server these requirements
# apply to
fhir:link @<OneOrMore_uri>?; # Links to the FHIR specification
fhir:capabilities @<canonical>; # Required Capability Statement
}
# An abstract server representing a client or sender in a message exchange
<TestScript.origin> EXTENDS @<BackboneElement> CLOSED {
fhir:index @<integer>; # The index of the abstract origin
# server starting at 1
fhir:profile @<Coding>; # FHIR-Client | FHIR-SDC-FormFiller
fhir:url @<url>?; # The url path of the origin server
}
# An abstract server representing a destination or receiver in a message exchange
<TestScript.destination> EXTENDS @<BackboneElement> CLOSED {
fhir:index @<integer>; # The index of the abstract
# destination server starting at 1
fhir:profile @<Coding>; # FHIR-Server | FHIR-SDC-FormManager
# | FHIR-SDC-FormReceiver |
# FHIR-SDC-FormProcessor
fhir:url @<url>?; # The url path of the destination
# server
}
# Each operation can have one or more header elements
<TestScript.setup.action.operation.requestHeader> EXTENDS @<BackboneElement> CLOSED {
fhir:field @<string>; # HTTP header field name
fhir:value @<string>; # HTTP headerfield value
}
# Indication of the artifact(s) that are tested by this test case
<TestScript.scope> EXTENDS @<BackboneElement> CLOSED {
fhir:artifact @<canonical>; # The specific conformance artifact
# being tested
fhir:conformance @<CodeableConcept>?; # required | optional | strict
fhir:phase @<CodeableConcept>?; # unit | integration | production
}
# A test operation or assert to perform
<TestScript.test.action> EXTENDS @<BackboneElement> CLOSED {
fhir:operation @<TestScript.setup.action.operation>?; # The setup operation to perform
fhir:assert @<TestScript.setup.action.assert>?; # The setup assertion to perform
}
# Links to the FHIR specification
<TestScript.metadata.link> EXTENDS @<BackboneElement> CLOSED {
fhir:url @<uri>; # URL to the specification
fhir:description @<string>?; # Short description
}
# The assertion to perform
<TestScript.setup.action.assert> EXTENDS @<BackboneElement> CLOSED {
fhir:label @<string>?; # Tracking/logging assertion label
fhir:description @<string>?; # Tracking/reporting assertion
# description
fhir:direction @<code> AND
{fhir:v @fhirvs:assert-direction-codes}?; # response | request
fhir:compareToSourceId @<string>?; # Id of the source fixture to be
# evaluated
fhir:compareToSourceExpression @<string>?; # The FHIRPath expression to
# evaluate against the source
# fixture
fhir:compareToSourcePath @<string>?; # XPath or JSONPath expression to
# evaluate against the source
# fixture
fhir:contentType @<code> AND
{fhir:v @fhirvs:mimetypes}?; # Mime type to compare against the
# 'Content-Type' header
fhir:defaultManualCompletion @<code> AND
{fhir:v @fhirvs:assert-manual-completion-codes}?; # fail | pass | skip | stop
fhir:expression @<string>?; # The FHIRPath expression to be
# evaluated
fhir:headerField @<string>?; # HTTP header field name
fhir:minimumId @<string>?; # Fixture Id of minimum content
# resource
fhir:navigationLinks @<boolean>?; # Perform validation on navigation
# links?
fhir:operator @<code> AND
{fhir:v @fhirvs:assert-operator-codes}?; # equals | notEquals | in | notIn |
# greaterThan | lessThan | empty |
# notEmpty | contains | notContains
# | eval | manualEval
fhir:path @<string>?; # XPath or JSONPath expression
fhir:requestMethod @<code> AND
{fhir:v @fhirvs:http-operations}?; # delete | get | options | patch |
# post | put | head
fhir:requestURL @<string>?; # Request URL comparison value
fhir:resource @<uri>?; # Resource type
fhir:response @<code> AND
{fhir:v @fhirvs:assert-response-code-types}?; # continue | switchingProtocols |
# okay | created | accepted |
# nonAuthoritativeInformation |
# noContent | resetContent |
# partialContent | multipleChoices |
# movedPermanently | found |
# seeOther | notModified | useProxy
# | temporaryRedirect |
# permanentRedirect | badRequest |
# unauthorized | paymentRequired |
# forbidden | notFound |
# methodNotAllowed | notAcceptable |
# proxyAuthenticationRequired |
# requestTimeout | conflict | gone |
# lengthRequired |
# preconditionFailed |
# contentTooLarge | uriTooLong |
# unsupportedMediaType |
# rangeNotSatisfiable |
# expectationFailed |
# misdirectedRequest |
# unprocessableContent |
# upgradeRequired |
# internalServerError |
# notImplemented | badGateway |
# serviceUnavailable |
# gatewayTimeout |
# httpVersionNotSupported
fhir:responseCode @<string>?; # HTTP response code to test
fhir:sourceId @<id>?; # Fixture Id of source expression or
# headerField
fhir:stopTestOnFail @<boolean>; # If this assert fails, will the
# current test execution stop?
fhir:validateProfileId @<id>?; # Profile Id of validation profile
# reference
fhir:value @<string>?; # The value to compare to
fhir:warningOnly @<boolean>; # Will this assert produce a warning
# only on error?
fhir:requirement @<OneOrMore_TestScript.setup.action.assert.requirement>?; # Links or references to the testing
# requirements
}
# A series of required setup operations before tests are executed
<TestScript.setup> EXTENDS @<BackboneElement> CLOSED {
fhir:action @<OneOrMore_TestScript.setup.action>; # A setup operation or assert to
# perform
}
# A setup operation or assert to perform
<TestScript.setup.action> EXTENDS @<BackboneElement> CLOSED {
fhir:operation @<TestScript.setup.action.operation>?; # The setup operation to perform
fhir:assert @<TestScript.setup.action.assert>?; # The assertion to perform
}
# Fixture in the test script - by reference (uri)
<TestScript.fixture> EXTENDS @<BackboneElement> CLOSED {
fhir:autocreate @<boolean>; # Whether or not to implicitly
# create the fixture during setup
fhir:autodelete @<boolean>; # Whether or not to implicitly
# delete the fixture during teardown
fhir:resource @<Reference> AND {fhir:link
@<Resource> ? }?; # Reference of the resource
}
# Links or references to the testing requirements
<TestScript.setup.action.assert.requirement> EXTENDS @<BackboneElement> CLOSED {
fhir:link @<uri> OR
(@<canonical> AND {fhir:link @<Requirements> }) ?; # Link or reference to the testing
# requirement
}
# A test in this script
<TestScript.test> EXTENDS @<BackboneElement> CLOSED {
fhir:name @<string>?; # Tracking/logging name of this test
fhir:description @<string>?; # Tracking/reporting short
# description of the test
fhir:action @<OneOrMore_TestScript.test.action>; # A test operation or assert to
# perform
}
# One or more teardown operations to perform
<TestScript.teardown.action> EXTENDS @<BackboneElement> CLOSED {
fhir:operation @<TestScript.setup.action.operation>; # The teardown operation to perform
}
# The setup operation to perform
<TestScript.setup.action.operation> EXTENDS @<BackboneElement> CLOSED {
fhir:type @<Coding>?; # The operation code type that will
# be executed
fhir:resource @<uri>?; # Resource type
fhir:label @<string>?; # Tracking/logging operation label
fhir:description @<string>?; # Tracking/reporting operation
# description
fhir:accept @<code> AND
{fhir:v @fhirvs:mimetypes}?; # Mime type to accept in the payload
# of the response, with charset etc
fhir:contentType @<code> AND
{fhir:v @fhirvs:mimetypes}?; # Mime type of the request payload
# contents, with charset etc
fhir:destination @<integer>?; # Server responding to the request
fhir:encodeRequestUrl @<boolean>; # Whether or not to send the request
# url in encoded format
fhir:method @<code> AND
{fhir:v @fhirvs:http-operations}?; # delete | get | options | patch |
# post | put | head
fhir:origin @<integer>?; # Server initiating the request
fhir:params @<string>?; # Explicitly defined path parameters
fhir:requestHeader @<OneOrMore_TestScript.setup.action.operation.requestHeader>?; # Each operation can have one or
# more header elements
fhir:requestId @<id>?; # Fixture Id of mapped request
fhir:responseId @<id>?; # Fixture Id of mapped response
fhir:sourceId @<id>?; # Fixture Id of body for PUT and
# POST requests
fhir:targetId @<id>?; # Id of fixture used for extracting
# the [id], [type], and [vid] for
# GET requests
fhir:url @<string>?; # Request URL
}
#---------------------- 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_TestScript.origin> CLOSED {
rdf:first @<TestScript.origin> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.origin>
}
<OneOrMore_TestScript.destination> CLOSED {
rdf:first @<TestScript.destination> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.destination>
}
<OneOrMore_TestScript.scope> CLOSED {
rdf:first @<TestScript.scope> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.scope>
}
<OneOrMore_TestScript.fixture> CLOSED {
rdf:first @<TestScript.fixture> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.fixture>
}
<OneOrMore_canonical> CLOSED {
rdf:first @<canonical> ;
rdf:rest [rdf:nil] OR @<OneOrMore_canonical>
}
<OneOrMore_TestScript.variable> CLOSED {
rdf:first @<TestScript.variable> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.variable>
}
<OneOrMore_TestScript.test> CLOSED {
rdf:first @<TestScript.test> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.test>
}
<OneOrMore_TestScript.teardown.action> CLOSED {
rdf:first @<TestScript.teardown.action> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.teardown.action>
}
<OneOrMore_TestScript.metadata.link> CLOSED {
rdf:first @<TestScript.metadata.link> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.metadata.link>
}
<OneOrMore_TestScript.metadata.capability> CLOSED {
rdf:first @<TestScript.metadata.capability> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.metadata.capability>
}
<OneOrMore_integer> CLOSED {
rdf:first @<integer> ;
rdf:rest [rdf:nil] OR @<OneOrMore_integer>
}
<OneOrMore_uri> CLOSED {
rdf:first @<uri> ;
rdf:rest [rdf:nil] OR @<OneOrMore_uri>
}
<OneOrMore_TestScript.setup.action.assert.requirement> CLOSED {
rdf:first @<TestScript.setup.action.assert.requirement> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.setup.action.assert.requirement>
}
<OneOrMore_TestScript.setup.action> CLOSED {
rdf:first @<TestScript.setup.action> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.setup.action>
}
<OneOrMore_TestScript.test.action> CLOSED {
rdf:first @<TestScript.test.action> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.test.action>
}
<OneOrMore_TestScript.setup.action.operation.requestHeader> CLOSED {
rdf:first @<TestScript.setup.action.operation.requestHeader> ;
rdf:rest [rdf:nil] OR @<OneOrMore_TestScript.setup.action.operation.requestHeader>
}
#---------------------- Value Sets ------------------------
# The type of direction to use for assertion.
fhirvs:assert-direction-codes ["response" "request"]
# The type of manual completion to use for assertion.
fhirvs:assert-manual-completion-codes ["fail" "pass" "skip" "stop"]
# The type of operator to use for assertion.
fhirvs:assert-operator-codes ["equals" "notEquals" "in" "notIn" "greaterThan" "lessThan" "empty" "notEmpty" "contains" "notContains" "eval" "manualEval"]
# The type of response code to use for assertion.
fhirvs:assert-response-code-types ["continue" "switchingProtocols" "okay" "created" "accepted" "nonAuthoritativeInformation" "noContent" "resetContent" "partialContent" "multipleChoices" "movedPermanently" "found" "seeOther" "notModified" "useProxy" "temporaryRedirect" "permanentRedirect" "badRequest" "unauthorized" "paymentRequired" "forbidden" "notFound" "methodNotAllowed" "notAcceptable" "proxyAuthenticationRequired" "requestTimeout" "conflict" "gone" "lengthRequired" "preconditionFailed" "contentTooLarge" "uriTooLong" "unsupportedMediaType" "rangeNotSatisfiable" "expectationFailed" "misdirectedRequest" "unprocessableContent" "upgradeRequired" "internalServerError" "notImplemented" "badGateway" "serviceUnavailable" "gatewayTimeout" "httpVersionNotSupported"]
# The allowable request method or HTTP operation codes.
fhirvs:http-operations ["delete" "get" "options" "patch" "post" "put" "head"]
# This value set includes all possible codes from BCP-13 (see http://tools.ietf.org/html/bcp13)
fhirvs:mimetypes xsd:string #EXTERNAL
# The lifecycle status of an artifact.
fhirvs:publication-status ["draft" "active" "retired" "unknown"]
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.
.
Page
versions:
R5
R4B
R4
R3
|
Propose
a
change
Foundation