Summary
Diagnostics
Care Provision
Request & Response
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Documents
Terminology
Definitional Artifacts
Evidence-Based Medicine
Quality Reporting & Testing
Medication Definition
Public Health & Research
Complex
Primitive
ActivityDefinition
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
Encounter
Group
Library
List
Measure
MedicinalProduct
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
StructureDefinition
StructureMap
ValueSet
default
The EventDefinition resource provides a reusable description of when a particular event can occur.
EventDefinition
Path
EventDefinition
Id
EventDefinition
Cardinality
0 - *
Definition
The EventDefinition resource provides a reusable description of when a particular event can occur.
Comment
Constraint
dom-2 [error]
If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3 [error]
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4 [error]
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5 [error]
If a resource is contained in another resource, it SHALL NOT have a security label
dom-6 [warning]
A resource should have narrative for robust management
evd-0 [warning]
Name should be usable as an identifier for the module by machine processing applications such as code generation
Path
EventDefinition.url
Id
EventDefinition.url
Type
Cardinality
0 - 1
Definition
An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers.
Comment
Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
Requirements
Allows the event definition to be referenced by a single globally unique identifier.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier
Id
EventDefinition.identifier
Type
Cardinality
0 - *
Definition
A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Comment
Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this event definition outside of FHIR, where it is not possible to use the logical URI.
Requirements
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-1
Path
EventDefinition.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.version
Id
EventDefinition.version
Type
Cardinality
0 - 1
Definition
The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Comment
There may be different event definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the event definition with the format [url]|[version].
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.name
Id
EventDefinition.name
Type
Cardinality
0 - 1
Definition
A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Comment
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Requirements
Support human navigation and code generation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
inv-0
Path
EventDefinition.title
Id
EventDefinition.title
Type
Cardinality
0 - 1
Definition
A short, descriptive, user-friendly title for the event definition.
Comment
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.subtitle
Id
EventDefinition.subtitle
Type
Cardinality
0 - 1
Definition
An explanatory or alternate title for the event definition giving additional information about its content.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.status
Id
EventDefinition.status
Type
Cardinality
1 - 1
Definition
The status of this event definition. Enables tracking the life-cycle of the content.
Comment
Allows filtering of event definitions that are appropriate for use versus not.
Binding
Strength
required
Description
The lifecycle status of an artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.experimental
Id
EventDefinition.experimental
Type
Cardinality
0 - 1
Definition
A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Comment
Allows filtering of event definitions that are appropriate for use versus not.
Requirements
Enables experimental content to be developed following the same lifecycle that would be used for a production-level event definition.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.subject[x]
Id
EventDefinition.subject[x]
Type
Cardinality
0 - 1
Definition
A code or group definition that describes the intended subject of the event definition.
Comment
Binding
Strength
extensible
Description
The possible types of subjects for an event (E.g. Patient, Practitioner, Organization, Location, etc.).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.subject[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.subject[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.subject[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.subject[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.subject[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.subject[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.date
Id
EventDefinition.date
Type
Cardinality
0 - 1
Definition
The date (and optionally time) when the event definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes.
Comment
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the event definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.publisher
Id
EventDefinition.publisher
Type
Cardinality
0 - 1
Definition
The name of the organization or individual that published the event definition.
Comment
Usually an organization but may be an individual. The publisher (or steward) of the event definition is the organization or individual primarily responsible for the maintenance and upkeep of the event definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the event definition. This item SHOULD be populated unless the information is available from context.
Requirements
Helps establish the "authority/credibility" of the event definition. May also allow for contact.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.contact
Id
EventDefinition.contact
Type
Cardinality
0 - *
Definition
Contact details to assist a user in finding and communicating with the publisher.
Comment
May be a web site, an email address, a telephone number, etc.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.contact.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.contact.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.contact.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
EventDefinition.contact.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.contact.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.contact.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.contact.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.contact.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.contact.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.description
Id
EventDefinition.description
Type
Cardinality
0 - 1
Definition
A free text natural language description of the event definition from a consumer's perspective.
Comment
This description can be used to capture details such as why the event definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the event definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the event definition is presumed to be the predominant language in the place the event definition was created).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext
Id
EventDefinition.useContext
Type
Cardinality
0 - *
Definition
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.
Comment
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Requirements
Assist in searching for appropriate content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.code
Id
UsageContext.code
Type
Cardinality
1 - 1
Definition
A code that identifies the type of context being specified by this usage context.
Comment
Binding
Strength
extensible
Description
A code that specifies a type of context being specified by a usage context.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.value[x]
Id
UsageContext.value[x]
Type
Cardinality
1 - 1
Definition
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Comment
Binding
Strength
example
Description
A code that defines the specific value for the context being specified.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.value[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.jurisdiction
Id
EventDefinition.jurisdiction
Type
Cardinality
0 - *
Definition
A legal or geographic region in which the event definition is intended to be used.
Comment
It may be possible for the event definition to be used in jurisdictions other than those for which it was originally designed or intended.
Binding
Strength
extensible
Description
Countries and regions within which this artifact is targeted for use.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.jurisdiction.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.jurisdiction.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.jurisdiction.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.jurisdiction.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.jurisdiction.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.jurisdiction.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.purpose
Id
EventDefinition.purpose
Type
Cardinality
0 - 1
Definition
Explanation of why this event definition is needed and why it has been designed as it has.
Comment
This element does not describe the usage of the event definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this event definition.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.usage
Id
EventDefinition.usage
Type
Cardinality
0 - 1
Definition
A detailed description of how the event definition is used from a clinical perspective.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.copyright
Id
EventDefinition.copyright
Type
Cardinality
0 - 1
Definition
A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.
Comment
Requirements
Consumers must be able to determine any legal restrictions on the use of the event definition and/or its content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.approvalDate
Id
EventDefinition.approvalDate
Type
Cardinality
0 - 1
Definition
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Comment
The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.lastReviewDate
Id
EventDefinition.lastReviewDate
Type
Cardinality
0 - 1
Definition
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Comment
If specified, this date follows the original approval date.
Requirements
Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.effectivePeriod
Id
EventDefinition.effectivePeriod
Type
Cardinality
0 - 1
Definition
The period during which the event definition content was or is planned to be in active use.
Comment
The effective period for a event definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
Requirements
Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the event definition are or are expected to be used instead.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.effectivePeriod.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.effectivePeriod.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.topic
Id
EventDefinition.topic
Type
Cardinality
0 - *
Definition
Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
Comment
Requirements
Repositories must be able to determine how to categorize the module so that it can be found by topical searches.
Binding
Strength
example
Description
High-level categorization of the definition, used for searching, sorting, and filtering.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.topic.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.topic.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.topic.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.topic.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.topic.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.topic.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.author
Id
EventDefinition.author
Type
Cardinality
0 - *
Definition
An individiual or organization primarily involved in the creation and maintenance of the content.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.author.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.author.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.author.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
EventDefinition.author.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.author.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.author.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.author.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.author.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.author.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.editor
Id
EventDefinition.editor
Type
Cardinality
0 - *
Definition
An individual or organization primarily responsible for internal coherence of the content.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.editor.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.editor.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.editor.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
EventDefinition.editor.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.editor.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.editor.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.editor.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.editor.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.editor.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.reviewer
Id
EventDefinition.reviewer
Type
Cardinality
0 - *
Definition
An individual or organization primarily responsible for review of some aspect of the content.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.reviewer.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.reviewer.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.reviewer.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
EventDefinition.reviewer.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.reviewer.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.reviewer.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.reviewer.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.reviewer.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.reviewer.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.endorser
Id
EventDefinition.endorser
Type
Cardinality
0 - *
Definition
An individual or organization responsible for officially endorsing the content for use in some setting.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.endorser.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.endorser.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.endorser.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
EventDefinition.endorser.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.endorser.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.endorser.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.endorser.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.endorser.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.endorser.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
EventDefinition.relatedArtifact
Id
EventDefinition.relatedArtifact
Type
Cardinality
0 - *
Definition
Related resources such as additional documentation, justification, or bibliographic references.
Comment
Each related resource is either an attachment, or a reference to another resource, but not both.
Requirements
Modules must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
type
documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Path
EventDefinition.relatedArtifact.RelatedArtifact.type
Id
RelatedArtifact.type
Type
Cardinality
1 - 1
Definition
The type of relationship to the related artifact.
Comment
Binding
Strength
required
Description
The type of relationship to the related artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.label
Id
RelatedArtifact.label
Type
Cardinality
0 - 1
Definition
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.display
Id
RelatedArtifact.display
Type
Cardinality
0 - 1
Definition
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.citation
Id
RelatedArtifact.citation
Type
Cardinality
0 - 1
Definition
A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Comment
Additional structured information about citations should be captured as extensions.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.url
Id
RelatedArtifact.url
Type
Cardinality
0 - 1
Definition
A url for the artifact that can be followed to access the actual content.
Comment
If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.document
Id
RelatedArtifact.document
Type
Cardinality
0 - 1
Definition
The document being referenced, represented as an attachment. This is exclusive with the resource element.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.document.Attachment.contentType
Id
Attachment.contentType
Type
Cardinality
0 - 1
Definition
Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
Comment
Requirements
Processors of the data need to be able to know how to interpret the data.
Binding
Strength
required
Description
The mime type of an attachment. Any valid mime type is allowed.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.document.Attachment.data
Id
Attachment.data
Type
Cardinality
0 - 1
Definition
The actual data of the attachment - a sequence of bytes, base64 encoded.
Comment
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Requirements
The data needs to able to be transmitted inline.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.document.Attachment.url
Id
Attachment.url
Type
Cardinality
0 - 1
Definition
A location where the data can be accessed.
Comment
If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
Requirements
The data needs to be transmitted by reference.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.document.Attachment.size
Id
Attachment.size
Type
Cardinality
0 - 1
Definition
The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Comment
The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
Requirements
Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.document.Attachment.hash
Id
Attachment.hash
Type
Cardinality
0 - 1
Definition
The calculated hash of the data using SHA-1. Represented using base64.
Comment
The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
Requirements
Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.document.Attachment.title
Id
Attachment.title
Type
Cardinality
0 - 1
Definition
A label or set of text to display in place of the data.
Comment
Requirements
Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.document.Attachment.creation
Id
Attachment.creation
Type
Cardinality
0 - 1
Definition
The date that the attachment was first created.
Comment
Requirements
This is often tracked as an integrity issue for use of the attachment.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.relatedArtifact.RelatedArtifact.resource
Id
RelatedArtifact.resource
Type
Cardinality
0 - 1
Definition
The related resource, such as a library, value set, profile, or other knowledge resource.
Comment
If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger
Id
EventDefinition.trigger
Type
Cardinality
1 - *
Definition
The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
type
named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Path
EventDefinition.trigger.TriggerDefinition.type
Id
TriggerDefinition.type
Type
Cardinality
1 - 1
Definition
The type of triggering event.
Comment
Binding
Strength
required
Description
The type of trigger.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.name
Id
TriggerDefinition.name
Type
Cardinality
0 - 1
Definition
A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.
Comment
An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x]
Id
TriggerDefinition.timing[x]
Type
Cardinality
0 - 1
Definition
The timing of the event (if this is a periodic trigger).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.event
Id
Timing.event
Type
Cardinality
0 - *
Definition
Identifies specific times when the event occurs.
Comment
Requirements
In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat
Id
Timing.repeat
Type
Cardinality
0 - 1
Definition
A set of rules that describe when the event is scheduled.
Comment
Requirements
Many timing schedules are determined by regular repetitions.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
tim-1 [error]
if there's a duration, there needs to be duration units
tim-2 [error]
if there's a period, there needs to be period units
tim-4 [error]
duration SHALL be a non-negative value
tim-5 [error]
period SHALL be a non-negative value
tim-6 [error]
If there's a periodMax, there must be a period
tim-7 [error]
If there's a durationMax, there must be a duration
tim-8 [error]
If there's a countMax, there must be a count
tim-9 [error]
If there's an offset, there must be a when (and not C, CM, CD, CV)
tim-10 [error]
If there's a timeOfDay, there cannot be a when, or vice versa
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.bounds[x]
Id
Timing.repeat.bounds[x]
Type
Cardinality
0 - 1
Definition
Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.count
Id
Timing.repeat.count
Type
Cardinality
0 - 1
Definition
A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
Comment
If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
Requirements
Repetitions may be limited by end time or total occurrences.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.countMax
Id
Timing.repeat.countMax
Type
Cardinality
0 - 1
Definition
If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.duration
Id
Timing.repeat.duration
Type
Cardinality
0 - 1
Definition
How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
Comment
For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Requirements
Some activities are not instantaneous and need to be maintained for a period of time.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.durationMax
Id
Timing.repeat.durationMax
Type
Cardinality
0 - 1
Definition
If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
Comment
For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Requirements
Some activities are not instantaneous and need to be maintained for a period of time.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.durationUnit
Id
Timing.repeat.durationUnit
Type
Cardinality
0 - 1
Definition
The units of time for the duration, in UCUM units.
Comment
Binding
Strength
required
Description
A unit of time (units from UCUM).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.frequency
Id
Timing.repeat.frequency
Type
Cardinality
0 - 1
Definition
The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.frequencyMax
Id
Timing.repeat.frequencyMax
Type
Cardinality
0 - 1
Definition
If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.period
Id
Timing.repeat.period
Type
Cardinality
0 - 1
Definition
Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.periodMax
Id
Timing.repeat.periodMax
Type
Cardinality
0 - 1
Definition
If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.periodUnit
Id
Timing.repeat.periodUnit
Type
Cardinality
0 - 1
Definition
The units of time for the period in UCUM units.
Comment
Binding
Strength
required
Description
A unit of time (units from UCUM).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.dayOfWeek
Id
Timing.repeat.dayOfWeek
Type
Cardinality
0 - *
Definition
If one or more days of week is provided, then the action happens only on the specified day(s).
Comment
If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.timeOfDay
Id
Timing.repeat.timeOfDay
Type
Cardinality
0 - *
Definition
Specified time of day for action to take place.
Comment
When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.when
Id
Timing.repeat.when
Type
Cardinality
0 - *
Definition
An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
Comment
When more than one event is listed, the event is tied to the union of the specified events.
Requirements
Timings are frequently determined by occurrences such as waking, eating and sleep.
Binding
Strength
required
Description
Real world event relating to the schedule.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.repeat.offset
Id
Timing.repeat.offset
Type
Cardinality
0 - 1
Definition
The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.code
Id
Timing.code
Type
Cardinality
0 - 1
Definition
A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
Comment
BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).
Binding
Strength
preferred
Description
Code for a known / defined timing pattern.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.timing[x].Timing.code.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data
Id
TriggerDefinition.data
Type
Cardinality
0 - *
Definition
The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
Comment
This element shall be present for any data type trigger.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.type
Id
DataRequirement.type
Type
Cardinality
1 - 1
Definition
The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Comment
Binding
Strength
required
Description
A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.profile
Id
DataRequirement.profile
Type
Cardinality
0 - *
Definition
The profile of the required data, specified as the uri of the profile definition.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
subject[x]
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.subject[x]
Id
DataRequirement.subject[x]
Type
Cardinality
0 - 1
Definition
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Comment
The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Binding
Strength
extensible
Description
The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.subject[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
mustSupport
Indicates specific structure elements that are referenced by the knowledge module
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.mustSupport
Id
DataRequirement.mustSupport
Type
Cardinality
0 - *
Definition
Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.
The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.codeFilter
Id
DataRequirement.codeFilter
Type
Cardinality
0 - *
Definition
Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Comment
Constraint
drq-1 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.codeFilter.path
Id
DataRequirement.codeFilter.path
Type
Cardinality
0 - 1
Definition
The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Comment
The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.codeFilter.searchParam
Id
DataRequirement.codeFilter.searchParam
Type
Cardinality
0 - 1
Definition
A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.codeFilter.valueSet
Id
DataRequirement.codeFilter.valueSet
Type
Cardinality
0 - 1
Definition
The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.codeFilter.code
Id
DataRequirement.codeFilter.code
Type
Cardinality
0 - *
Definition
The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.dateFilter
Id
DataRequirement.dateFilter
Type
Cardinality
0 - *
Definition
Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Comment
Constraint
drq-2 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.dateFilter.path
Id
DataRequirement.dateFilter.path
Type
Cardinality
0 - 1
Definition
The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Comment
The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.dateFilter.searchParam
Id
DataRequirement.dateFilter.searchParam
Type
Cardinality
0 - 1
Definition
A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.dateFilter.value[x]
Id
DataRequirement.dateFilter.value[x]
Type
Cardinality
0 - 1
Definition
The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.limit
Id
DataRequirement.limit
Type
Cardinality
0 - 1
Definition
Specifies a maximum number of results that are required (uses the _count search parameter).
Comment
This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.sort
Id
DataRequirement.sort
Type
Cardinality
0 - *
Definition
Specifies the order of the results to be returned.
Comment
This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.sort.path
Id
DataRequirement.sort.path
Type
Cardinality
1 - 1
Definition
The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.data.DataRequirement.sort.direction
Id
DataRequirement.sort.direction
Type
Cardinality
1 - 1
Definition
The direction of the sort, ascending or descending.
Comment
Binding
Strength
required
Description
The possible sort directions, ascending or descending.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.condition
Id
TriggerDefinition.condition
Type
Cardinality
0 - 1
Definition
A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.
Comment
This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.
Requirements
Need to be able to formally describe the triggering criteria.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.condition.Expression.description
Id
Expression.description
Type
Cardinality
0 - 1
Definition
A brief, natural language description of the condition that effectively communicates the intended semantics.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.condition.Expression.name
Id
Expression.name
Type
Cardinality
0 - 1
Definition
A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.condition.Expression.expression
Id
Expression.expression
Type
Cardinality
0 - 1
Definition
An expression in the specified language that returns a value.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
EventDefinition.trigger.TriggerDefinition.condition.Expression.reference
Id
Expression.reference
Type
Cardinality
0 - 1
Definition
A URI that defines where the expression is found.
Comment
If both a reference and an expression is found, the reference SHALL point to the same expression.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children