PREFIX fhir:
PREFIX fhirvs:
PREFIX xsd:
BASE
start=@ AND {fhir:nodeRole [fhir:treeRoot]}
# The definition of a plan for a series of actions, independent of any specific patient or context
CLOSED {
a [fhir:PlanDefinition];
fhir:nodeRole [fhir:treeRoot]?;
fhir:Resource.id id?; # Logical id of this artifact
fhir:Resource.meta @?; # Metadata about the resource
fhir:Resource.implicitRules @?; # A set of rules under which this
# content was created
fhir:Resource.language @?; # Language of the resource content
fhir:DomainResource.text @?; # Text summary of the resource, for
# human interpretation
fhir:DomainResource.contained @*; # Contained, inline Resources
fhir:DomainResource.extension @*; # Additional content defined by
# implementations
fhir:DomainResource.modifierExtension @*; # Extensions that cannot be ignored
fhir:PlanDefinition.url @?; # Canonical identifier for this plan
# definition, represented as a URI
# (globally unique)
fhir:PlanDefinition.identifier @*; # Additional identifier for the plan
# definition
fhir:PlanDefinition.version @?; # Business version of the plan
# definition
fhir:PlanDefinition.name @?; # Name for this plan definition
# (computer friendly)
fhir:PlanDefinition.title @?; # Name for this plan definition
# (human friendly)
fhir:PlanDefinition.subtitle @?; # Subordinate title of the plan
# definition
fhir:PlanDefinition.type @?; # order-set | clinical-protocol |
# eca-rule | workflow-definition
fhir:PlanDefinition.status @ AND
{fhir:value @fhirvs:publication-status}; # draft | active | retired | unknown
fhir:PlanDefinition.experimental @?; # For testing purposes, not real
# usage
( # Type of individual the plan
# definition is focused on
fhir:PlanDefinition.subjectCodeableConcept @ |
fhir:PlanDefinition.subjectReference @ |
fhir:PlanDefinition.subjectCanonical @
)?;
fhir:PlanDefinition.date @?; # Date last changed
fhir:PlanDefinition.publisher @?; # Name of the publisher
# (organization or individual)
fhir:PlanDefinition.contact @*; # Contact details for the publisher
fhir:PlanDefinition.description @?; # Natural language description of
# the plan definition
fhir:PlanDefinition.useContext @*; # The context that the content is
# intended to support
fhir:PlanDefinition.jurisdiction @*; # Intended jurisdiction for plan
# definition (if applicable)
fhir:PlanDefinition.purpose @?; # Why this plan definition is defined
fhir:PlanDefinition.usage @?; # Describes the clinical usage of
# the plan
fhir:PlanDefinition.copyright @?; # Use and/or publishing restrictions
fhir:PlanDefinition.approvalDate @?; # When the plan definition was
# approved by publisher
fhir:PlanDefinition.lastReviewDate @?; # When the plan definition was last
# reviewed
fhir:PlanDefinition.effectivePeriod @?; # When the plan definition is
# expected to be used
fhir:PlanDefinition.topic @*; # E.g. Education, Treatment,
# Assessment
fhir:PlanDefinition.author @*; # Who authored the content
fhir:PlanDefinition.editor @*; # Who edited the content
fhir:PlanDefinition.reviewer @*; # Who reviewed the content
fhir:PlanDefinition.endorser @*; # Who endorsed the content
fhir:PlanDefinition.relatedArtifact @*; # Additional documentation, citations
fhir:PlanDefinition.library @*; # Logic used by the plan definition
fhir:PlanDefinition.goal @*; # What the plan is trying to
# accomplish
fhir:PlanDefinition.action @*; # Action defined by the plan
fhir:index xsd:integer? # Relative position in a list
}
# What the plan is trying to accomplish
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:PlanDefinition.goal.category @?; # E.g. Treatment, dietary, behavioral
fhir:PlanDefinition.goal.description @; # Code or text describing the goal
fhir:PlanDefinition.goal.priority @?; # high-priority | medium-priority |
# low-priority
fhir:PlanDefinition.goal.start @?; # When goal pursuit begins
fhir:PlanDefinition.goal.addresses @*; # What does the goal address
fhir:PlanDefinition.goal.documentation @*; # Supporting documentation for the
# goal
fhir:PlanDefinition.goal.target @*; # Target outcome for the goal
fhir:index xsd:integer? # Relative position in a list
}
# Action defined by the plan
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:PlanDefinition.action.prefix @?; # User-visible prefix for the action
# (e.g. 1. or A.)
fhir:PlanDefinition.action.title @?; # User-visible title
fhir:PlanDefinition.action.description @?; # Brief description of the action
fhir:PlanDefinition.action.textEquivalent @?; # Static text equivalent of the
# action, used if the dynamic
# aspects cannot be interpreted by
# the receiving system
fhir:PlanDefinition.action.priority @ AND
{fhir:value @fhirvs:request-priority}?; # routine | urgent | asap | stat
fhir:PlanDefinition.action.code @*; # Code representing the meaning of
# the action or sub-actions
fhir:PlanDefinition.action.reason @*; # Why the action should be performed
fhir:PlanDefinition.action.documentation @*; # Supporting documentation for the
# intended performer of the action
fhir:PlanDefinition.action.goalId @*; # What goals this action supports
( # Type of individual the action is
# focused on
fhir:PlanDefinition.action.subjectCodeableConcept @ |
fhir:PlanDefinition.action.subjectReference @ |
fhir:PlanDefinition.action.subjectCanonical @
)?;
fhir:PlanDefinition.action.trigger @*; # When the action should be triggered
fhir:PlanDefinition.action.condition @*; # Whether or not the action is
# applicable
fhir:PlanDefinition.action.input @*; # Input data requirements
fhir:PlanDefinition.action.output @*; # Output data definition
fhir:PlanDefinition.action.relatedAction @*; # Relationship to another action
( # When the action should take place
fhir:PlanDefinition.action.timingDateTime @ |
fhir:PlanDefinition.action.timingAge @ |
fhir:PlanDefinition.action.timingPeriod @ |
fhir:PlanDefinition.action.timingDuration @ |
fhir:PlanDefinition.action.timingRange @ |
fhir:PlanDefinition.action.timingTiming @
)?;
fhir:PlanDefinition.action.participant @*; # Who should participate in the
# action
fhir:PlanDefinition.action.type @?; # create | update | remove |
# fire-event
fhir:PlanDefinition.action.groupingBehavior @ AND
{fhir:value @fhirvs:action-grouping-behavior}?; # visual-group | logical-group |
# sentence-group
fhir:PlanDefinition.action.selectionBehavior @ AND
{fhir:value @fhirvs:action-selection-behavior}?; # any | all | all-or-none |
# exactly-one | at-most-one |
# one-or-more
fhir:PlanDefinition.action.requiredBehavior @ AND
{fhir:value @fhirvs:action-required-behavior}?; # must | could |
# must-unless-documented
fhir:PlanDefinition.action.precheckBehavior @ AND
{fhir:value @fhirvs:action-precheck-behavior}?; # yes | no
fhir:PlanDefinition.action.cardinalityBehavior @ AND
{fhir:value @fhirvs:action-cardinality-behavior}?; # single | multiple
( # Description of the activity to be
# performed
fhir:PlanDefinition.action.definitionCanonical @ |
fhir:PlanDefinition.action.definitionUri @
)?;
fhir:PlanDefinition.action.transform @?; # Transform to apply the template
fhir:PlanDefinition.action.dynamicValue @*; # Dynamic aspects of the definition
fhir:PlanDefinition.action.action @*; # A sub-action
fhir:index xsd:integer? # Relative position in a list
}
# Who should participate in the action
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:PlanDefinition.action.participant.type @ AND
{fhir:value @fhirvs:action-participant-type}; # patient | practitioner |
# related-person | device
fhir:PlanDefinition.action.participant.role @?; # E.g. Nurse, Surgeon, Parent
fhir:index xsd:integer? # Relative position in a list
}
# Whether or not the action is applicable
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:PlanDefinition.action.condition.kind @ AND
{fhir:value @fhirvs:action-condition-kind}; # applicability | start | stop
fhir:PlanDefinition.action.condition.expression @?; # Boolean-valued expression
fhir:index xsd:integer? # Relative position in a list
}
# Dynamic aspects of the definition
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:PlanDefinition.action.dynamicValue.path @?; # The path to the element to be set
# dynamically
fhir:PlanDefinition.action.dynamicValue.expression @?; # An expression that provides the
# dynamic value for the
# customization
fhir:index xsd:integer? # Relative position in a list
}
# A sub-action
CLOSED {
fhir:index xsd:integer? # Relative position in a list
}
# Target outcome for the goal
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:PlanDefinition.goal.target.measure @?; # The parameter whose value is to be
# tracked
( # The target value to be achieved
fhir:PlanDefinition.goal.target.detailQuantity @ |
fhir:PlanDefinition.goal.target.detailRange @ |
fhir:PlanDefinition.goal.target.detailCodeableConcept @
)?;
fhir:PlanDefinition.goal.target.due @?; # Reach goal within
fhir:index xsd:integer? # Relative position in a list
}
# Relationship to another action
CLOSED {
fhir:Element.id string?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:BackboneElement.modifierExtension @*; # Extensions that cannot be ignored
# even if unrecognized
fhir:PlanDefinition.action.relatedAction.actionId @; # What action is this related to
fhir:PlanDefinition.action.relatedAction.relationship @ AND
{fhir:value @fhirvs:action-relationship-type}; # before-start | before | before-end
# | concurrent-with-start |
# concurrent | concurrent-with-end |
# after-start | after | after-end
( # Time offset for the relationship
fhir:PlanDefinition.action.relatedAction.offsetDuration @ |
fhir:PlanDefinition.action.relatedAction.offsetRange @
)?;
fhir:index xsd:integer? # Relative position in a list
}
#---------------------- Data Types -------------------
# Primitive Type dateTime
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value dateTime?; # Primitive value for dateTime
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type date
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value date?; # Primitive value for date
fhir:index xsd:integer? # Relative position in a list
}
# Metadata about a resource
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Meta.versionId @?; # Version specific identifier
fhir:Meta.lastUpdated @?; # When the resource version last
# changed
fhir:Meta.source @?; # Identifies where the resource
# comes from
fhir:Meta.profile @*; # Profiles this resource claims to
# conform to
fhir:Meta.security @*; # Security Labels applied to this
# resource
fhir:Meta.tag @*; # Tags applied to this resource
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type code
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.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
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value string MAXLENGTH 1048576?; # Primitive value for string
fhir:index xsd:integer? # Relative position in a list
}
# Describes a required data item
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:DataRequirement.type @ AND
{fhir:value @fhirvs:all-types}; # The type of the required data
fhir:DataRequirement.profile @*; # The profile of the required data
( # E.g. Patient, Practitioner,
# RelatedPerson, Organization,
# Location, Device
fhir:DataRequirement.subjectCodeableConcept @ |
fhir:DataRequirement.subjectReference @
)?;
fhir:DataRequirement.mustSupport @*; # Indicates specific structure
# elements that are referenced by
# the knowledge module
fhir:DataRequirement.codeFilter @*; # What codes are expected
fhir:DataRequirement.dateFilter @*; # What dates/date ranges are expected
fhir:DataRequirement.limit @?; # Number of results
fhir:DataRequirement.sort @*; # Order of the results
fhir:index xsd:integer? # Relative position in a list
}
# An identifier intended for computation
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Identifier.use @ AND
{fhir:value @fhirvs:identifier-use}?; # usual | official | temp |
# secondary | old (If known)
fhir:Identifier.type @?; # Description of identifier
fhir:Identifier.system @?; # The namespace for the identifier
# value
fhir:Identifier.value @?; # The value that is unique
fhir:Identifier.period @?; # Time period when id is/was valid
# for use
fhir:Identifier.assigner @?; # Organization that issued id (may
# be just text)
fhir:index xsd:integer? # Relative position in a list
}
# Human-readable summary of the resource (essential clinical and business information)
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Narrative.status @ 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
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.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
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value id?; # Primitive value for id
fhir:index xsd:integer? # Relative position in a list
}
# A duration of time during which an organism (or a process) has existed
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Quantity.value @?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @ AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @?; # Unit representation
fhir:Quantity.system @?; # System that defines coded unit form
fhir:Quantity.code @?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A reference from one resource to another
CLOSED {
fhir:link IRI?;
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Reference.reference @?; # Literal reference, Relative,
# internal or absolute URL
fhir:Reference.type @?; # Type the reference refers to (e.g.
# "Patient")
fhir:Reference.identifier @?; # Logical reference, when literal
# reference is not known
fhir:Reference.display @?; # Text alternative for the resource
fhir:index xsd:integer? # Relative position in a list
}
# Defines an expected trigger for a module
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:TriggerDefinition.type @ 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 @?; # Name or URI that identifies the
# event
( # Timing of the event
fhir:TriggerDefinition.timingTiming @ |
fhir:TriggerDefinition.timingReference @ |
fhir:TriggerDefinition.timingDate @ |
fhir:TriggerDefinition.timingDateTime @
)?;
fhir:TriggerDefinition.data @*; # Triggering data of the event
# (multiple = 'and')
fhir:TriggerDefinition.condition @?; # Whether the event triggers
# (boolean expression)
fhir:index xsd:integer? # Relative position in a list
}
# Base Resource
{a .+;
fhir:Resource.id id?; # Logical id of this artifact
fhir:Resource.meta @?; # Metadata about the resource
fhir:Resource.implicitRules @?; # A set of rules under which this
# content was created
fhir:Resource.language @?; # Language of the resource content
fhir:index xsd:integer?
}
# Time range defined by start and end date/time
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Period.start @?; # Starting time with inclusive
# boundary
fhir:Period.end @?; # End time with inclusive boundary,
# if not ongoing
fhir:index xsd:integer? # Relative position in a list
}
# A measured or measurable amount
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Quantity.value @?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @ AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @?; # Unit representation
fhir:Quantity.system @?; # System that defines coded unit form
fhir:Quantity.code @?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# A length of time
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Quantity.value @?; # Numerical value (with implicit
# precision)
fhir:Quantity.comparator @ AND
{fhir:value @fhirvs:quantity-comparator}?; # < | <= | >= | > - how to
# understand the value
fhir:Quantity.unit @?; # Unit representation
fhir:Quantity.system @?; # System that defines coded unit form
fhir:Quantity.code @?; # Coded form of the unit
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type canonical
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:value canonical?; # Primitive value for canonical
fhir:index xsd:integer? # Relative position in a list
}
# Related artifacts for a knowledge resource
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:RelatedArtifact.type @ AND
{fhir:value @fhirvs:related-artifact-type}; # documentation | justification |
# citation | predecessor | successor
# | derived-from | depends-on |
# composed-of
fhir:RelatedArtifact.label @?; # Short label
fhir:RelatedArtifact.display @?; # Brief description of the related
# artifact
fhir:RelatedArtifact.citation @?; # Bibliographic citation for the
# artifact
fhir:RelatedArtifact.url @?; # Where the artifact can be accessed
fhir:RelatedArtifact.document @?; # What document is being referenced
fhir:RelatedArtifact.resource @?; # What resource is being referenced
fhir:index xsd:integer? # Relative position in a list
}
# Set of values bounded by low and high
CLOSED {
fhir:Element.id id?; # Unique id for inter-element
# referencing
fhir:Element.extension @*; # Additional content defined by
# implementations
fhir:Range.low @?; # Low limit
fhir:Range.high @?; # High limit
fhir:index xsd:integer? # Relative position in a list
}
# Primitive Type uri
CLOSED {
fhir:Element.id string?; # xml:id (or equivalent in JSON)
fhir:Element.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
CLOSED {
fhir:Element.id id?;
fhir:Element.extension @*;
fhir:Extension.url uri;
(
fhir:Extension.valueBase64Binary @ |
fhir:Extension.valueBoolean @ |
fhir:Extension.valueCanonical @ |
fhir:Extension.valueCode @ |
fhir:Extension.valueDate @ |
fhir:Extension.valueDateTime @ |
fhir:Extension.valueDecimal @ |
fhir:Extension.valueId @ |
fhir:Extension.valueInstant @ |
fhir:Extension.valueInteger @ |
fhir:Extension.valueMarkdown @ |
fhir:Extension.valueOid @ |
fhir:Extension.valuePositiveInt @ |
fhir:Extension.valueString @ |
fhir:Extension.valueTime @