Create StructureDefinition Resource
post
oracle-fhir-server/fhir/StructureDefinition
This api lets you create a new instance of the StructureDefinition resource.
Request
There are no request parameters for this operation.
Supported Media Types
- application/fhir+json
Root Schema : schema
Type:
Show Source
object
-
_abstract: object
Element
Base definition for all elements in a resource.
-
_contextInvariant: array
_contextInvariant
Extensions for contextInvariant
-
_copyright: object
Element
Base definition for all elements in a resource.
-
_copyrightLabel: object
Element
Base definition for all elements in a resource.
-
_date: object
Element
Base definition for all elements in a resource.
-
_derivation: object
Element
Base definition for all elements in a resource.
-
_description: object
Element
Base definition for all elements in a resource.
-
_experimental: object
Element
Base definition for all elements in a resource.
-
_fhirVersion: object
Element
Base definition for all elements in a resource.
-
_implicitRules: object
Element
Base definition for all elements in a resource.
-
_kind: object
Element
Base definition for all elements in a resource.
-
_language: object
Element
Base definition for all elements in a resource.
-
_name: object
Element
Base definition for all elements in a resource.
-
_publisher: object
Element
Base definition for all elements in a resource.
-
_purpose: object
Element
Base definition for all elements in a resource.
-
_status: object
Element
Base definition for all elements in a resource.
-
_title: object
Element
Base definition for all elements in a resource.
-
_type: object
Element
Base definition for all elements in a resource.
-
_url: object
Element
Base definition for all elements in a resource.
-
_version: object
Element
Base definition for all elements in a resource.
-
_versionAlgorithmString: object
Element
Base definition for all elements in a resource.
-
abstract: boolean
Pattern:
^true|false$
Value of "true" or "false" -
baseDefinition: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource -
contact: array
contact
Contact details to assist a user in finding and communicating with the publisher.
-
contained: array
contained
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
-
context: array
context
Identifies the types of resource or data type elements to which the extension can be applied. For more guidance on using the 'context' element, see the [defining extensions page](defining-extensions.html#context).
-
contextInvariant: array
contextInvariant
A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.
-
copyright: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
copyrightLabel: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
date: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a UTC offset SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates. -
derivation: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
description: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
differential: object
StructureDefinition_Differential
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
experimental: boolean
Pattern:
^true|false$
Value of "true" or "false" -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
fhirVersion: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
id: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive. -
identifier: array
identifier
A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
implicitRules: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
jurisdiction: array
jurisdiction
A legal or geographic region in which the structure definition is intended to be used.
-
keyword: array
keyword
(DEPRECATED) A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.
-
kind: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
language: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
mapping: array
mapping
An external specification that the content is mapped to.
-
meta: object
Meta
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
-
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
name: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
publisher: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
purpose: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
resourceType(required):
This is a StructureDefinition resource
-
snapshot: object
StructureDefinition_Snapshot
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
status: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
text: object
Narrative
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
-
title: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
type: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
url: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
useContext: array
useContext
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 structure definition instances.
-
version: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
versionAlgorithmCoding: object
Coding
A reference to a code defined by a terminology system.
-
versionAlgorithmString: string
Pattern:
^^[\s\S]+$$
Indicates the mechanism used to compare versions to determine which is more current.
Nested Schema : Element
Type:
object
Base definition for all elements in a resource.
Show Source
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : _contextInvariant
Type:
array
Extensions for contextInvariant
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : contact
Type:
array
Contact details to assist a user in finding and communicating with the publisher.
Show Source
-
Array of:
object ContactDetail
Specifies contact information for a person or organization.
Nested Schema : contained
Type:
array
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Show Source
-
Array of:
object ResourceList
One of FHIR Resource: Ref: FHIR R5 specification.
Nested Schema : context
Type:
array
Identifies the types of resource or data type elements to which the extension can be applied. For more guidance on using the 'context' element, see the [defining extensions page](defining-extensions.html#context).
Show Source
-
Array of:
object StructureDefinition_Context
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
Nested Schema : contextInvariant
Type:
array
A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.
Show Source
-
Array of:
string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : StructureDefinition_Differential
Type:
object
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
Show Source
-
element(required): array
element
Captures constraints on each element within the resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : identifier
Type:
array
A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Show Source
-
Array of:
object Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Nested Schema : jurisdiction
Type:
array
A legal or geographic region in which the structure definition is intended to be used.
Show Source
-
Array of:
object CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Nested Schema : keyword
Type:
array
(DEPRECATED) A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.
Show Source
-
Array of:
object Coding
A reference to a code defined by a terminology system.
Nested Schema : mapping
Type:
array
An external specification that the content is mapped to.
Show Source
-
Array of:
object StructureDefinition_Mapping
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
Nested Schema : Meta
Type:
object
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Show Source
-
_lastUpdated: object
Element
Base definition for all elements in a resource.
-
_source: object
Element
Base definition for all elements in a resource.
-
_versionId: object
Element
Base definition for all elements in a resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
lastUpdated: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
An instant in time - known at least to the second -
profile: array
profile
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
-
security: array
security
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
-
source: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
tag: array
tag
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
-
versionId: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : StructureDefinition_Snapshot
Type:
object
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
Show Source
-
element(required): array
element
Captures constraints on each element within the resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Nested Schema : Narrative
Type:
object
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
Show Source
-
_status: object
Element
Base definition for all elements in a resource.
-
div(required):
xhtml - escaped html (see specfication)
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
status:
Allowed Values:
[ "generated", "extensions", "additional", "empty" ]
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Nested Schema : useContext
Type:
array
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 structure definition instances.
Show Source
-
Array of:
object UsageContext
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
Nested Schema : Coding
Type:
object
A reference to a code defined by a terminology system.
Show Source
-
_code: object
Element
Base definition for all elements in a resource.
-
_display: object
Element
Base definition for all elements in a resource.
-
_system: object
Element
Base definition for all elements in a resource.
-
_userSelected: object
Element
Base definition for all elements in a resource.
-
_version: object
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
display: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
userSelected: boolean
Pattern:
^true|false$
Value of "true" or "false" -
version: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : Extension
Type:
object
Optional Extension Element - found in all resources.
Show Source
-
_url: object
Element
Base definition for all elements in a resource.
-
_valueBase64Binary: object
Element
Base definition for all elements in a resource.
-
_valueBoolean: object
Element
Base definition for all elements in a resource.
-
_valueCanonical: object
Element
Base definition for all elements in a resource.
-
_valueCode: object
Element
Base definition for all elements in a resource.
-
_valueDate: object
Element
Base definition for all elements in a resource.
-
_valueDateTime: object
Element
Base definition for all elements in a resource.
-
_valueDecimal: object
Element
Base definition for all elements in a resource.
-
_valueId: object
Element
Base definition for all elements in a resource.
-
_valueInstant: object
Element
Base definition for all elements in a resource.
-
_valueInteger: object
Element
Base definition for all elements in a resource.
-
_valueInteger64: object
Element
Base definition for all elements in a resource.
-
_valueMarkdown: object
Element
Base definition for all elements in a resource.
-
_valueOid: object
Element
Base definition for all elements in a resource.
-
_valuePositiveInt: object
Element
Base definition for all elements in a resource.
-
_valueString: object
Element
Base definition for all elements in a resource.
-
_valueTime: object
Element
Base definition for all elements in a resource.
-
_valueUnsignedInt: object
Element
Base definition for all elements in a resource.
-
_valueUri: object
Element
Base definition for all elements in a resource.
-
_valueUrl: object
Element
Base definition for all elements in a resource.
-
_valueUuid: object
Element
Base definition for all elements in a resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
url: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
valueAddress: object
Address
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
-
valueAge: object
Age
A duration of time during which an organism (or a process) has existed.
-
valueAnnotation: object
Annotation
A text note which also contains information about who made the statement and when.
-
valueAttachment: object
Attachment
For referring to data content defined in other formats.
-
valueAvailability: object
Availability
Availability data for an {item}.
-
valueBase64Binary: string
Pattern:
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueBoolean: boolean
Pattern:
^true|false$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueCanonical: string
Pattern:
^\S*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueCode: string
Pattern:
^[^\s]+( [^\s]+)*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueCodeableConcept: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
valueCodeableReference: object
CodeableReference
A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
-
valueCoding: object
Coding
A reference to a code defined by a terminology system.
-
valueContactDetail: object
ContactDetail
Specifies contact information for a person or organization.
-
valueContactPoint: object
ContactPoint
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
valueCount: object
Count
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
valueDataRequirement: object
DataRequirement
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
valueDate: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueDecimal: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueDistance: object
Distance
A length - a value with a unit that is a physical distance.
-
valueDosage: object
Dosage
Indicates how the medication is/was taken or should be taken by the patient.
-
valueDuration: object
Duration
A length of time.
-
valueExpression: object
Expression
A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.
-
valueExtendedContactDetail: object
ExtendedContactDetail
Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.
-
valueHumanName: object
HumanName
A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.
-
valueId: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueIdentifier: object
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
valueInstant: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueInteger: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueInteger64: string
Pattern:
^[0]|[-+]?[1-9][0-9]*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueMarkdown: string
Pattern:
^^[\s\S]+$$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueMeta: object
Meta
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
-
valueMoney: object
Money
An amount of economic utility in some recognized currency.
-
valueOid: string
Pattern:
^urn:oid:[0-2](\.(0|[1-9][0-9]*))+$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueParameterDefinition: object
ParameterDefinition
The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
-
valuePeriod: object
Period
A time period defined by a start and end date and optionally time.
-
valuePositiveInt: number
Pattern:
^[1-9][0-9]*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
valueRange: object
Range
A set of ordered Quantities defined by a low and high limit.
-
valueRatio: object
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
valueRatioRange: object
RatioRange
A range of ratios expressed as a low and high numerator and a denominator.
-
valueReference: object
Reference
A reference from one resource to another.
-
valueRelatedArtifact: object
RelatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
valueSampledData: object
SampledData
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
-
valueSignature: object
Signature
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
-
valueString: string
Pattern:
^^[\s\S]+$$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueTiming: object
Timing
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
valueTriggerDefinition: object
TriggerDefinition
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
-
valueUnsignedInt: number
Pattern:
^[0]|([1-9][0-9]*)$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueUri: string
Pattern:
^\S*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueUrl: string
Pattern:
^\S*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueUsageContext: object
UsageContext
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
-
valueUuid: string
Pattern:
^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : Address
Type:
object
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
Show Source
-
_city: object
Element
Base definition for all elements in a resource.
-
_country: object
Element
Base definition for all elements in a resource.
-
_district: object
Element
Base definition for all elements in a resource.
-
_line: array
_line
Extensions for line
-
_postalCode: object
Element
Base definition for all elements in a resource.
-
_state: object
Element
Base definition for all elements in a resource.
-
_text: object
Element
Base definition for all elements in a resource.
-
_type: object
Element
Base definition for all elements in a resource.
-
_use: object
Element
Base definition for all elements in a resource.
-
city: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
country: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
district: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
line: array
line
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
-
period: object
Period
A time period defined by a start and end date and optionally time.
-
postalCode: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
state: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
text: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
type:
Allowed Values:
[ "postal", "physical", "both" ]
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. -
use:
Allowed Values:
[ "home", "work", "temp", "old", "billing" ]
The purpose of this address.
Nested Schema : Age
Type:
object
A duration of time during which an organism (or a process) has existed.
Show Source
-
_code: object
Element
Base definition for all elements in a resource.
-
_comparator: object
Element
Base definition for all elements in a resource.
-
_system: object
Element
Base definition for all elements in a resource.
-
_unit: object
Element
Base definition for all elements in a resource.
-
_value: object
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
comparator:
Allowed Values:
[ "<", "<=", ">=", ">", "ad" ]
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div> "> -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision
Nested Schema : Annotation
Type:
object
A text note which also contains information about who made the statement and when.
Show Source
-
_authorString: object
Element
Base definition for all elements in a resource.
-
_text: object
Element
Base definition for all elements in a resource.
-
_time: object
Element
Base definition for all elements in a resource.
-
authorReference: object
Reference
A reference from one resource to another.
-
authorString: string
Pattern:
^^[\s\S]+$$
The individual responsible for making the annotation. -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
text: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
time: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a UTC offset SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Nested Schema : Attachment
Type:
object
For referring to data content defined in other formats.
Show Source
-
_contentType: object
Element
Base definition for all elements in a resource.
-
_creation: object
Element
Base definition for all elements in a resource.
-
_data: object
Element
Base definition for all elements in a resource.
-
_duration: object
Element
Base definition for all elements in a resource.
-
_frames: object
Element
Base definition for all elements in a resource.
-
_hash: object
Element
Base definition for all elements in a resource.
-
_height: object
Element
Base definition for all elements in a resource.
-
_language: object
Element
Base definition for all elements in a resource.
-
_pages: object
Element
Base definition for all elements in a resource.
-
_size: object
Element
Base definition for all elements in a resource.
-
_title: object
Element
Base definition for all elements in a resource.
-
_url: object
Element
Base definition for all elements in a resource.
-
_width: object
Element
Base definition for all elements in a resource.
-
contentType: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
creation: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a UTC offset SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates. -
data: string
A stream of bytes
-
duration: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
frames: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
hash: string
A stream of bytes
-
height: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
language: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
pages: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
size: string
Pattern:
^[0]|[-+]?[1-9][0-9]*$
A very large whole number -
title: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
url: string
Pattern:
^\S*$
A URI that is a literal reference -
width: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0)
Nested Schema : Availability
Type:
object
Availability data for an {item}.
Show Source
-
availableTime: array
availableTime
Times the {item} is available.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
notAvailableTime: array
notAvailableTime
Not available during this time due to provided reason.
Nested Schema : CodeableConcept
Type:
object
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Show Source
-
_text: object
Element
Base definition for all elements in a resource.
-
coding: array
coding
A reference to a code defined by a terminology system.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
text: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : CodeableReference
Type:
object
A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
Show Source
-
concept: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
reference: object
Reference
A reference from one resource to another.
Nested Schema : ContactDetail
Type:
object
Specifies contact information for a person or organization.
Show Source
-
_name: object
Element
Base definition for all elements in a resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
name: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
telecom: array
telecom
The contact details for the individual (if a name was provided) or the organization.
Nested Schema : ContactPoint
Type:
object
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
Show Source
-
_rank: object
Element
Base definition for all elements in a resource.
-
_system: object
Element
Base definition for all elements in a resource.
-
_use: object
Element
Base definition for all elements in a resource.
-
_value: object
Element
Base definition for all elements in a resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
period: object
Period
A time period defined by a start and end date and optionally time.
-
rank: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
system:
Allowed Values:
[ "phone", "fax", "email", "pager", "url", "sms", "other" ]
Telecommunications form for contact point - what communications system is required to make use of the contact. -
use:
Allowed Values:
[ "home", "work", "temp", "old", "mobile" ]
Identifies the purpose for the contact point. -
value: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : Count
Type:
object
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
Show Source
-
_code: object
Element
Base definition for all elements in a resource.
-
_comparator: object
Element
Base definition for all elements in a resource.
-
_system: object
Element
Base definition for all elements in a resource.
-
_unit: object
Element
Base definition for all elements in a resource.
-
_value: object
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
comparator:
Allowed Values:
[ "<", "<=", ">=", ">", "ad" ]
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div> "> -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision
Nested Schema : DataRequirement
Type:
object
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Show Source
-
_limit: object
Element
Base definition for all elements in a resource.
-
_mustSupport: array
_mustSupport
Extensions for mustSupport
-
_type: object
Element
Base definition for all elements in a resource.
-
codeFilter: array
codeFilter
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.
-
dateFilter: array
dateFilter
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.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
limit: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
mustSupport: array
mustSupport
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 resolvable 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).
-
profile: array
profile
The profile of the required data, specified as the uri of the profile definition.
-
sort: array
sort
Specifies the order of the results to be returned.
-
subjectCodeableConcept: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
subjectReference: object
Reference
A reference from one resource to another.
-
type: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
valueFilter: array
valueFilter
Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).
Nested Schema : Distance
Type:
object
A length - a value with a unit that is a physical distance.
Show Source
-
_code: object
Element
Base definition for all elements in a resource.
-
_comparator: object
Element
Base definition for all elements in a resource.
-
_system: object
Element
Base definition for all elements in a resource.
-
_unit: object
Element
Base definition for all elements in a resource.
-
_value: object
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
comparator:
Allowed Values:
[ "<", "<=", ">=", ">", "ad" ]
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div> "> -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision
Nested Schema : Dosage
Type:
object
Indicates how the medication is/was taken or should be taken by the patient.
Show Source
-
_asNeeded: object
Element
Base definition for all elements in a resource.
-
_patientInstruction: object
Element
Base definition for all elements in a resource.
-
_sequence: object
Element
Base definition for all elements in a resource.
-
_text: object
Element
Base definition for all elements in a resource.
-
additionalInstruction: array
additionalInstruction
Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
-
asNeeded: boolean
Pattern:
^true|false$
Value of "true" or "false" -
asNeededFor: array
asNeededFor
Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).
-
doseAndRate: array
doseAndRate
Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
maxDosePerAdministration: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
maxDosePerLifetime: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
maxDosePerPeriod: array
maxDosePerPeriod
Upper limit on medication per unit of time.
-
method: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
patientInstruction: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
route: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
sequence: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
A whole number -
site: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
text: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
timing: object
Timing
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
Nested Schema : Duration
Type:
object
A length of time.
Show Source
-
_code: object
Element
Base definition for all elements in a resource.
-
_comparator: object
Element
Base definition for all elements in a resource.
-
_system: object
Element
Base definition for all elements in a resource.
-
_unit: object
Element
Base definition for all elements in a resource.
-
_value: object
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
comparator:
Allowed Values:
[ "<", "<=", ">=", ">", "ad" ]
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div> "> -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision
Nested Schema : Expression
Type:
object
A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.
Show Source
-
_description: object
Element
Base definition for all elements in a resource.
-
_expression: object
Element
Base definition for all elements in a resource.
-
_language: object
Element
Base definition for all elements in a resource.
-
_name: object
Element
Base definition for all elements in a resource.
-
_reference: object
Element
Base definition for all elements in a resource.
-
description: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
expression: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
language: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
name: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
reference: string
Pattern:
^\S*$
String of characters used to identify a name or a resource
Nested Schema : ExtendedContactDetail
Type:
object
Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.
Show Source
-
address: object
Address
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
name: array
name
The name of an individual to contact, some types of contact detail are usually blank.
-
organization: object
Reference
A reference from one resource to another.
-
period: object
Period
A time period defined by a start and end date and optionally time.
-
purpose: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
telecom: array
telecom
The contact details application for the purpose defined.
Nested Schema : HumanName
Type:
object
A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.
Show Source
-
_family: object
Element
Base definition for all elements in a resource.
-
_given: array
_given
Extensions for given
-
_prefix: array
_prefix
Extensions for prefix
-
_suffix: array
_suffix
Extensions for suffix
-
_text: object
Element
Base definition for all elements in a resource.
-
_use: object
Element
Base definition for all elements in a resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
family: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
given: array
given
Given name.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
period: object
Period
A time period defined by a start and end date and optionally time.
-
prefix: array
prefix
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
-
suffix: array
suffix
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
-
text: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
use:
Allowed Values:
[ "usual", "official", "temp", "nickname", "anonymous", "old", "maiden" ]
Identifies the purpose for this name.
Nested Schema : Identifier
Type:
object
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Show Source
-
_system: object
Element
Base definition for all elements in a resource.
-
_use: object
Element
Base definition for all elements in a resource.
-
_value: object
Element
Base definition for all elements in a resource.
-
assigner: object
Reference
A reference from one resource to another.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
period: object
Period
A time period defined by a start and end date and optionally time.
-
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
type: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
use:
Allowed Values:
[ "usual", "official", "temp", "secondary", "old" ]
The purpose of this identifier. -
value: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : Money
Type:
object
An amount of economic utility in some recognized currency.
Show Source
-
_currency: object
Element
Base definition for all elements in a resource.
-
_value: object
Element
Base definition for all elements in a resource.
-
currency: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision
Nested Schema : ParameterDefinition
Type:
object
The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
Show Source
-
_documentation: object
Element
Base definition for all elements in a resource.
-
_max: object
Element
Base definition for all elements in a resource.
-
_min: object
Element
Base definition for all elements in a resource.
-
_name: object
Element
Base definition for all elements in a resource.
-
_type: object
Element
Base definition for all elements in a resource.
-
_use: object
Element
Base definition for all elements in a resource.
-
documentation: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
max: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
min: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
A whole number -
name: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
profile: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource -
type: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
use: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Nested Schema : Period
Type:
object
A time period defined by a start and end date and optionally time.
Show Source
-
_end: object
Element
Base definition for all elements in a resource.
-
_start: object
Element
Base definition for all elements in a resource.
-
end: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a UTC offset SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates. -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
start: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a UTC offset SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Nested Schema : Quantity
Type:
object
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
Show Source
-
_code: object
Element
Base definition for all elements in a resource.
-
_comparator: object
Element
Base definition for all elements in a resource.
-
_system: object
Element
Base definition for all elements in a resource.
-
_unit: object
Element
Base definition for all elements in a resource.
-
_value: object
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
comparator:
Allowed Values:
[ "<", "<=", ">=", ">", "ad" ]
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.< div> "> -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision
Nested Schema : Range
Type:
object
A set of ordered Quantities defined by a low and high limit.
Show Source
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
high: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
low: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
Nested Schema : Ratio
Type:
object
A relationship of two Quantity values - expressed as a numerator and a denominator.
Show Source
-
denominator: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
numerator: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
Nested Schema : RatioRange
Type:
object
A range of ratios expressed as a low and high numerator and a denominator.
Show Source
-
denominator: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
highNumerator: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
lowNumerator: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
Nested Schema : Reference
Type:
object
A reference from one resource to another.
Show Source
-
_display: object
Element
Base definition for all elements in a resource.
-
_reference: object
Element
Base definition for all elements in a resource.
-
_type: object
Element
Base definition for all elements in a resource.
-
display: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
identifier: object
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
reference: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
type: string
Pattern:
^\S*$
String of characters used to identify a name or a resource
Nested Schema : RelatedArtifact
Type:
object
Related artifacts such as additional documentation, justification, or bibliographic references.
Show Source
-
_citation: object
Element
Base definition for all elements in a resource.
-
_display: object
Element
Base definition for all elements in a resource.
-
_label: object
Element
Base definition for all elements in a resource.
-
_publicationDate: object
Element
Base definition for all elements in a resource.
-
_publicationStatus: object
Element
Base definition for all elements in a resource.
-
_type: object
Element
Base definition for all elements in a resource.
-
citation: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
classifier: array
classifier
Provides additional classifiers of the related artifact.
-
display: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
document: object
Attachment
For referring to data content defined in other formats.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
label: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
publicationDate: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
A date or partial date (e.g. just year or year + month). There is no UTC offset. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates. -
publicationStatus: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
resource: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource -
resourceReference: object
Reference
A reference from one resource to another.
-
type:
Allowed Values:
[ "documentation", "justification", "citation", "predecessor", "successor", "derived-from", "depends-on", "composed-of", "part-of", "amends", "amended-with", "appends", "appended-with", "cites", "cited-by", "comments-on", "comment-in", "contains", "contained-in", "corrects", "correction-in", "replaces", "replaced-with", "retracts", "retracted-by", "signs", "similar-to", "supports", "supported-with", "transforms", "transformed-into", "transformed-with", "documents", "specification-of", "created-with", "cite-as" ]
The type of relationship to the related artifact.
Nested Schema : SampledData
Type:
object
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
Show Source
-
_data: object
Element
Base definition for all elements in a resource.
-
_dimensions: object
Element
Base definition for all elements in a resource.
-
_factor: object
Element
Base definition for all elements in a resource.
-
_interval: object
Element
Base definition for all elements in a resource.
-
_intervalUnit: object
Element
Base definition for all elements in a resource.
-
_lowerLimit: object
Element
Base definition for all elements in a resource.
-
_offsets: object
Element
Base definition for all elements in a resource.
-
_upperLimit: object
Element
Base definition for all elements in a resource.
-
codeMap: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource -
data: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
dimensions: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
factor: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision -
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
interval: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision -
intervalUnit: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
lowerLimit: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision -
offsets: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
origin(required): object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
upperLimit: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision
Nested Schema : Signature
Type:
object
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
Show Source
-
_data: object
Element
Base definition for all elements in a resource.
-
_sigFormat: object
Element
Base definition for all elements in a resource.
-
_targetFormat: object
Element
Base definition for all elements in a resource.
-
_when: object
Element
Base definition for all elements in a resource.
-
data: string
A stream of bytes
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
onBehalfOf: object
Reference
A reference from one resource to another.
-
sigFormat: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
targetFormat: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
type: array
type
An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
-
when: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
An instant in time - known at least to the second -
who: object
Reference
A reference from one resource to another.
Nested Schema : Timing
Type:
object
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
Show Source
-
_event: array
_event
Extensions for event
-
code: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
event: array
event
Identifies specific times when the event occurs.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
repeat: object
Timing_Repeat
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
Nested Schema : TriggerDefinition
Type:
object
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
Show Source
-
_name: object
Element
Base definition for all elements in a resource.
-
_timingDate: object
Element
Base definition for all elements in a resource.
-
_timingDateTime: object
Element
Base definition for all elements in a resource.
-
_type: object
Element
Base definition for all elements in a resource.
-
code: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
condition: object
Expression
A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.
-
data: array
data
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.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
name: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
subscriptionTopic: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource -
timingDate: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
The timing of the event (if this is a periodic trigger). -
timingDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
The timing of the event (if this is a periodic trigger). -
timingReference: object
Reference
A reference from one resource to another.
-
timingTiming: object
Timing
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
type:
Allowed Values:
[ "named-event", "periodic", "data-changed", "data-added", "data-modified", "data-removed", "data-accessed", "data-access-ended" ]
The type of triggering event.
Nested Schema : UsageContext
Type:
object
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
Show Source
-
code(required): object
Coding
A reference to a code defined by a terminology system.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
valueCodeableConcept: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
valueQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
valueRange: object
Range
A set of ordered Quantities defined by a low and high limit.
-
valueReference: object
Reference
A reference from one resource to another.
Nested Schema : _line
Type:
array
Extensions for line
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : line
Type:
array
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Show Source
-
Array of:
string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : availableTime
Type:
array
Times the {item} is available.
Show Source
-
Array of:
object Availability_AvailableTime
Availability data for an {item}.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : notAvailableTime
Type:
array
Not available during this time due to provided reason.
Show Source
-
Array of:
object Availability_NotAvailableTime
Availability data for an {item}.
Nested Schema : Availability_AvailableTime
Type:
object
Availability data for an {item}.
Show Source
-
_allDay: object
Element
Base definition for all elements in a resource.
-
_availableEndTime: object
Element
Base definition for all elements in a resource.
-
_availableStartTime: object
Element
Base definition for all elements in a resource.
-
_daysOfWeek: array
_daysOfWeek
Extensions for daysOfWeek
-
allDay: boolean
Pattern:
^true|false$
Value of "true" or "false" -
availableEndTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
A time during the day, with no date specified -
availableStartTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
A time during the day, with no date specified -
daysOfWeek: array
daysOfWeek
mon | tue | wed | thu | fri | sat | sun.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Nested Schema : _daysOfWeek
Type:
array
Extensions for daysOfWeek
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : daysOfWeek
Type:
array
mon | tue | wed | thu | fri | sat | sun.
Show Source
-
Array of:
string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : Availability_NotAvailableTime
Type:
object
Availability data for an {item}.
Show Source
-
_description: object
Element
Base definition for all elements in a resource.
-
description: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
during: object
Period
A time period defined by a start and end date and optionally time.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : coding
Type:
array
A reference to a code defined by a terminology system.
Show Source
-
Array of:
object Coding
A reference to a code defined by a terminology system.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : telecom
Type:
array
The contact details for the individual (if a name was provided) or the organization.
Show Source
-
Array of:
object ContactPoint
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : _mustSupport
Type:
array
Extensions for mustSupport
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : codeFilter
Type:
array
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.
Show Source
-
Array of:
object DataRequirement_CodeFilter
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Nested Schema : dateFilter
Type:
array
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.
Show Source
-
Array of:
object DataRequirement_DateFilter
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : mustSupport
Type:
array
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 resolvable 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).
Show Source
-
Array of:
string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : profile
Type:
array
The profile of the required data, specified as the uri of the profile definition.
Show Source
-
Array of:
string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource
Nested Schema : sort
Type:
array
Specifies the order of the results to be returned.
Show Source
-
Array of:
object DataRequirement_Sort
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Nested Schema : valueFilter
Type:
array
Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).
Show Source
-
Array of:
object DataRequirement_ValueFilter
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Nested Schema : DataRequirement_CodeFilter
Type:
object
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Show Source
-
_path: object
Element
Base definition for all elements in a resource.
-
_searchParam: object
Element
Base definition for all elements in a resource.
-
code: array
code
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.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
path: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
searchParam: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
valueSet: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource
Nested Schema : code
Type:
array
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.
Show Source
-
Array of:
object Coding
A reference to a code defined by a terminology system.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : DataRequirement_DateFilter
Type:
object
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Show Source
-
_path: object
Element
Base definition for all elements in a resource.
-
_searchParam: object
Element
Base definition for all elements in a resource.
-
_valueDateTime: object
Element
Base definition for all elements in a resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
path: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
searchParam: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
valueDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
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. -
valueDuration: object
Duration
A length of time.
-
valuePeriod: object
Period
A time period defined by a start and end date and optionally time.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : DataRequirement_Sort
Type:
object
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Show Source
-
_direction: object
Element
Base definition for all elements in a resource.
-
_path: object
Element
Base definition for all elements in a resource.
-
direction:
Allowed Values:
[ "ascending", "descending" ]
The direction of the sort, ascending or descending. -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
path: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : DataRequirement_ValueFilter
Type:
object
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Show Source
-
_comparator: object
Element
Base definition for all elements in a resource.
-
_path: object
Element
Base definition for all elements in a resource.
-
_searchParam: object
Element
Base definition for all elements in a resource.
-
_valueDateTime: object
Element
Base definition for all elements in a resource.
-
comparator: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
path: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
searchParam: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
valueDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
The value of the filter. -
valueDuration: object
Duration
A length of time.
-
valuePeriod: object
Period
A time period defined by a start and end date and optionally time.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : additionalInstruction
Type:
array
Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
Show Source
-
Array of:
object CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Nested Schema : asNeededFor
Type:
array
Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).
Show Source
-
Array of:
object CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Nested Schema : doseAndRate
Type:
array
Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.
Show Source
-
Array of:
object Dosage_DoseAndRate
Indicates how the medication is/was taken or should be taken by the patient.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : maxDosePerPeriod
Type:
array
Upper limit on medication per unit of time.
Show Source
-
Array of:
object Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : Dosage_DoseAndRate
Type:
object
Indicates how the medication is/was taken or should be taken by the patient.
Show Source
-
doseQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
doseRange: object
Range
A set of ordered Quantities defined by a low and high limit.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
rateQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
rateRange: object
Range
A set of ordered Quantities defined by a low and high limit.
-
rateRatio: object
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
type: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : name
Type:
array
The name of an individual to contact, some types of contact detail are usually blank.
Show Source
-
Array of:
object HumanName
A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.
Nested Schema : telecom
Type:
array
The contact details application for the purpose defined.
Show Source
-
Array of:
object ContactPoint
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
Nested Schema : _given
Type:
array
Extensions for given
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _prefix
Type:
array
Extensions for prefix
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _suffix
Type:
array
Extensions for suffix
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : given
Type:
array
Given name.
Show Source
-
Array of:
string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : prefix
Type:
array
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Show Source
-
Array of:
string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : suffix
Type:
array
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Show Source
-
Array of:
string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : classifier
Type:
array
Provides additional classifiers of the related artifact.
Show Source
-
Array of:
object CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : type
Type:
array
An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
Show Source
-
Array of:
object Coding
A reference to a code defined by a terminology system.
Nested Schema : _event
Type:
array
Extensions for event
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : event
Type:
array
Identifies specific times when the event occurs.
Show Source
-
Array of:
string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a UTC offset SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : Timing_Repeat
Type:
object
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
Show Source
-
_count: object
Element
Base definition for all elements in a resource.
-
_countMax: object
Element
Base definition for all elements in a resource.
-
_dayOfWeek: array
_dayOfWeek
Extensions for dayOfWeek
-
_duration: object
Element
Base definition for all elements in a resource.
-
_durationMax: object
Element
Base definition for all elements in a resource.
-
_durationUnit: object
Element
Base definition for all elements in a resource.
-
_frequency: object
Element
Base definition for all elements in a resource.
-
_frequencyMax: object
Element
Base definition for all elements in a resource.
-
_offset: object
Element
Base definition for all elements in a resource.
-
_period: object
Element
Base definition for all elements in a resource.
-
_periodMax: object
Element
Base definition for all elements in a resource.
-
_periodUnit: object
Element
Base definition for all elements in a resource.
-
_timeOfDay: array
_timeOfDay
Extensions for timeOfDay
-
_when: array
_when
Extensions for when
-
boundsDuration: object
Duration
A length of time.
-
boundsPeriod: object
Period
A time period defined by a start and end date and optionally time.
-
boundsRange: object
Range
A set of ordered Quantities defined by a low and high limit.
-
count: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
countMax: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
dayOfWeek: array
dayOfWeek
If one or more days of week is provided, then the action happens only on the specified day(s).
-
duration: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision -
durationMax: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision -
durationUnit:
Allowed Values:
[ "s", "min", "h", "d", "wk", "mo", "a" ]
The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
frequency: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
frequencyMax: number
Pattern:
^[1-9][0-9]*$
An integer with a value that is positive (e.g. >0) -
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
offset: number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0) -
period: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision -
periodMax: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
A rational number with implicit precision -
periodUnit:
Allowed Values:
[ "s", "min", "h", "d", "wk", "mo", "a" ]
The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. -
timeOfDay: array
timeOfDay
Specified time of day for action to take place.
-
when: array
when
An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
Nested Schema : _dayOfWeek
Type:
array
Extensions for dayOfWeek
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _timeOfDay
Type:
array
Extensions for timeOfDay
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _when
Type:
array
Extensions for when
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : dayOfWeek
Type:
array
If one or more days of week is provided, then the action happens only on the specified day(s).
Show Source
-
Array of:
string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : timeOfDay
Type:
array
Specified time of day for action to take place.
Show Source
-
Array of:
string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
A time during the day, with no date specified
Nested Schema : when
Type:
array
An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
Show Source
-
Array of:
Allowed Values:
[ "MORN", "MORN.early", "MORN.late", "NOON", "AFT", "AFT.early", "AFT.late", "EVE", "EVE.early", "EVE.late", "NIGHT", "PHS", "IMD", "HS", "WAKE", "C", "CM", "CD", "CV", "AC", "ACM", "ACD", "ACV", "PC", "PCM", "PCD", "PCV" ]
Nested Schema : data
Type:
array
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.
Show Source
-
Array of:
object DataRequirement
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : ResourceList
Type:
object
One of FHIR Resource: Ref: FHIR R5 specification.
Nested Schema : StructureDefinition_Context
Type:
object
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
Show Source
-
_expression: object
Element
Base definition for all elements in a resource.
-
_type: object
Element
Base definition for all elements in a resource.
-
expression: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
type: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : element
Type:
array
Captures constraints on each element within the resource.
Show Source
-
Array of:
object ElementDefinition
Captures constraints on each element within the resource, profile, or extension.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : ElementDefinition
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_alias: array
_alias
Extensions for alias
-
_comment: object
Element
Base definition for all elements in a resource.
-
_condition: array
_condition
Extensions for condition
-
_contentReference: object
Element
Base definition for all elements in a resource.
-
_defaultValueBase64Binary: object
Element
Base definition for all elements in a resource.
-
_defaultValueBoolean: object
Element
Base definition for all elements in a resource.
-
_defaultValueCanonical: object
Element
Base definition for all elements in a resource.
-
_defaultValueCode: object
Element
Base definition for all elements in a resource.
-
_defaultValueDate: object
Element
Base definition for all elements in a resource.
-
_defaultValueDateTime: object
Element
Base definition for all elements in a resource.
-
_defaultValueDecimal: object
Element
Base definition for all elements in a resource.
-
_defaultValueId: object
Element
Base definition for all elements in a resource.
-
_defaultValueInstant: object
Element
Base definition for all elements in a resource.
-
_defaultValueInteger: object
Element
Base definition for all elements in a resource.
-
_defaultValueInteger64: object
Element
Base definition for all elements in a resource.
-
_defaultValueMarkdown: object
Element
Base definition for all elements in a resource.
-
_defaultValueOid: object
Element
Base definition for all elements in a resource.
-
_defaultValuePositiveInt: object
Element
Base definition for all elements in a resource.
-
_defaultValueString: object
Element
Base definition for all elements in a resource.
-
_defaultValueTime: object
Element
Base definition for all elements in a resource.
-
_defaultValueUnsignedInt: object
Element
Base definition for all elements in a resource.
-
_defaultValueUri: object
Element
Base definition for all elements in a resource.
-
_defaultValueUrl: object
Element
Base definition for all elements in a resource.
-
_defaultValueUuid: object
Element
Base definition for all elements in a resource.
-
_definition: object
Element
Base definition for all elements in a resource.
-
_fixedBase64Binary: object
Element
Base definition for all elements in a resource.
-
_fixedBoolean: object
Element
Base definition for all elements in a resource.
-
_fixedCanonical: object
Element
Base definition for all elements in a resource.
-
_fixedCode: object
Element
Base definition for all elements in a resource.
-
_fixedDate: object
Element
Base definition for all elements in a resource.
-
_fixedDateTime: object
Element
Base definition for all elements in a resource.
-
_fixedDecimal: object
Element
Base definition for all elements in a resource.
-
_fixedId: object
Element
Base definition for all elements in a resource.
-
_fixedInstant: object
Element
Base definition for all elements in a resource.
-
_fixedInteger: object
Element
Base definition for all elements in a resource.
-
_fixedInteger64: object
Element
Base definition for all elements in a resource.
-
_fixedMarkdown: object
Element
Base definition for all elements in a resource.
-
_fixedOid: object
Element
Base definition for all elements in a resource.
-
_fixedPositiveInt: object
Element
Base definition for all elements in a resource.
-
_fixedString: object
Element
Base definition for all elements in a resource.
-
_fixedTime: object
Element
Base definition for all elements in a resource.
-
_fixedUnsignedInt: object
Element
Base definition for all elements in a resource.
-
_fixedUri: object
Element
Base definition for all elements in a resource.
-
_fixedUrl: object
Element
Base definition for all elements in a resource.
-
_fixedUuid: object
Element
Base definition for all elements in a resource.
-
_isModifier: object
Element
Base definition for all elements in a resource.
-
_isModifierReason: object
Element
Base definition for all elements in a resource.
-
_isSummary: object
Element
Base definition for all elements in a resource.
-
_label: object
Element
Base definition for all elements in a resource.
-
_max: object
Element
Base definition for all elements in a resource.
-
_maxLength: object
Element
Base definition for all elements in a resource.
-
_maxValueDate: object
Element
Base definition for all elements in a resource.
-
_maxValueDateTime: object
Element
Base definition for all elements in a resource.
-
_maxValueDecimal: object
Element
Base definition for all elements in a resource.
-
_maxValueInstant: object
Element
Base definition for all elements in a resource.
-
_maxValueInteger: object
Element
Base definition for all elements in a resource.
-
_maxValueInteger64: object
Element
Base definition for all elements in a resource.
-
_maxValuePositiveInt: object
Element
Base definition for all elements in a resource.
-
_maxValueTime: object
Element
Base definition for all elements in a resource.
-
_maxValueUnsignedInt: object
Element
Base definition for all elements in a resource.
-
_meaningWhenMissing: object
Element
Base definition for all elements in a resource.
-
_min: object
Element
Base definition for all elements in a resource.
-
_minValueDate: object
Element
Base definition for all elements in a resource.
-
_minValueDateTime: object
Element
Base definition for all elements in a resource.
-
_minValueDecimal: object
Element
Base definition for all elements in a resource.
-
_minValueInstant: object
Element
Base definition for all elements in a resource.
-
_minValueInteger: object
Element
Base definition for all elements in a resource.
-
_minValueInteger64: object
Element
Base definition for all elements in a resource.
-
_minValuePositiveInt: object
Element
Base definition for all elements in a resource.
-
_minValueTime: object
Element
Base definition for all elements in a resource.
-
_minValueUnsignedInt: object
Element
Base definition for all elements in a resource.
-
_mustHaveValue: object
Element
Base definition for all elements in a resource.
-
_mustSupport: object
Element
Base definition for all elements in a resource.
-
_orderMeaning: object
Element
Base definition for all elements in a resource.
-
_path: object
Element
Base definition for all elements in a resource.
-
_patternBase64Binary: object
Element
Base definition for all elements in a resource.
-
_patternBoolean: object
Element
Base definition for all elements in a resource.
-
_patternCanonical: object
Element
Base definition for all elements in a resource.
-
_patternCode: object
Element
Base definition for all elements in a resource.
-
_patternDate: object
Element
Base definition for all elements in a resource.
-
_patternDateTime: object
Element
Base definition for all elements in a resource.
-
_patternDecimal: object
Element
Base definition for all elements in a resource.
-
_patternId: object
Element
Base definition for all elements in a resource.
-
_patternInstant: object
Element
Base definition for all elements in a resource.
-
_patternInteger: object
Element
Base definition for all elements in a resource.
-
_patternInteger64: object
Element
Base definition for all elements in a resource.
-
_patternMarkdown: object
Element
Base definition for all elements in a resource.
-
_patternOid: object
Element
Base definition for all elements in a resource.
-
_patternPositiveInt: object
Element
Base definition for all elements in a resource.
-
_patternString: object
Element
Base definition for all elements in a resource.
-
_patternTime: object
Element
Base definition for all elements in a resource.
-
_patternUnsignedInt: object
Element
Base definition for all elements in a resource.
-
_patternUri: object
Element
Base definition for all elements in a resource.
-
_patternUrl: object
Element
Base definition for all elements in a resource.
-
_patternUuid: object
Element
Base definition for all elements in a resource.
-
_representation: array
_representation
Extensions for representation
-
_requirements: object
Element
Base definition for all elements in a resource.
-
_short: object
Element
Base definition for all elements in a resource.
-
_sliceIsConstraining: object
Element
Base definition for all elements in a resource.
-
_sliceName: object
Element
Base definition for all elements in a resource.
-
alias: array
alias
Identifies additional names by which this element might also be known.
-
base: object
ElementDefinition_Base
Captures constraints on each element within the resource, profile, or extension.
-
binding: object
ElementDefinition_Binding
Captures constraints on each element within the resource, profile, or extension.
-
code: array
code
A code that has the same meaning as the element in a particular terminology.
-
comment: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
condition: array
condition
A reference to an invariant that may make additional statements about the cardinality or value in the instance.
-
constraint: array
constraint
Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
-
contentReference: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
defaultValueAddress: object
Address
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
-
defaultValueAge: object
Age
A duration of time during which an organism (or a process) has existed.
-
defaultValueAnnotation: object
Annotation
A text note which also contains information about who made the statement and when.
-
defaultValueAttachment: object
Attachment
For referring to data content defined in other formats.
-
defaultValueAvailability: object
Availability
Availability data for an {item}.
-
defaultValueBase64Binary: string
Pattern:
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueBoolean: boolean
Pattern:
^true|false$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueCanonical: string
Pattern:
^\S*$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueCode: string
Pattern:
^[^\s]+( [^\s]+)*$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueCodeableConcept: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
defaultValueCodeableReference: object
CodeableReference
A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
-
defaultValueCoding: object
Coding
A reference to a code defined by a terminology system.
-
defaultValueContactDetail: object
ContactDetail
Specifies contact information for a person or organization.
-
defaultValueContactPoint: object
ContactPoint
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
defaultValueCount: object
Count
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
defaultValueDataRequirement: object
DataRequirement
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
defaultValueDate: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueDecimal: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueDistance: object
Distance
A length - a value with a unit that is a physical distance.
-
defaultValueDosage: object
Dosage
Indicates how the medication is/was taken or should be taken by the patient.
-
defaultValueDuration: object
Duration
A length of time.
-
defaultValueExpression: object
Expression
A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.
-
defaultValueExtendedContactDetail: object
ExtendedContactDetail
Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.
-
defaultValueHumanName: object
HumanName
A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.
-
defaultValueId: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueIdentifier: object
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
defaultValueInstant: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueInteger: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueInteger64: string
Pattern:
^[0]|[-+]?[1-9][0-9]*$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueMarkdown: string
Pattern:
^^[\s\S]+$$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueMeta: object
Meta
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
-
defaultValueMoney: object
Money
An amount of economic utility in some recognized currency.
-
defaultValueOid: string
Pattern:
^urn:oid:[0-2](\.(0|[1-9][0-9]*))+$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueParameterDefinition: object
ParameterDefinition
The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
-
defaultValuePeriod: object
Period
A time period defined by a start and end date and optionally time.
-
defaultValuePositiveInt: number
Pattern:
^[1-9][0-9]*$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
defaultValueRange: object
Range
A set of ordered Quantities defined by a low and high limit.
-
defaultValueRatio: object
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
defaultValueRatioRange: object
RatioRange
A range of ratios expressed as a low and high numerator and a denominator.
-
defaultValueReference: object
Reference
A reference from one resource to another.
-
defaultValueRelatedArtifact: object
RelatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
defaultValueSampledData: object
SampledData
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
-
defaultValueSignature: object
Signature
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
-
defaultValueString: string
Pattern:
^^[\s\S]+$$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueTiming: object
Timing
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
defaultValueTriggerDefinition: object
TriggerDefinition
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
-
defaultValueUnsignedInt: number
Pattern:
^[0]|([1-9][0-9]*)$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueUri: string
Pattern:
^\S*$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueUrl: string
Pattern:
^\S*$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
defaultValueUsageContext: object
UsageContext
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
-
defaultValueUuid: string
Pattern:
^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). -
definition: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
example: array
example
A sample value for this element demonstrating the type of information that would typically be found in the element.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
fixedAddress: object
Address
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
-
fixedAge: object
Age
A duration of time during which an organism (or a process) has existed.
-
fixedAnnotation: object
Annotation
A text note which also contains information about who made the statement and when.
-
fixedAttachment: object
Attachment
For referring to data content defined in other formats.
-
fixedAvailability: object
Availability
Availability data for an {item}.
-
fixedBase64Binary: string
Pattern:
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedBoolean: boolean
Pattern:
^true|false$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedCanonical: string
Pattern:
^\S*$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedCode: string
Pattern:
^[^\s]+( [^\s]+)*$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedCodeableConcept: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
fixedCodeableReference: object
CodeableReference
A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
-
fixedCoding: object
Coding
A reference to a code defined by a terminology system.
-
fixedContactDetail: object
ContactDetail
Specifies contact information for a person or organization.
-
fixedContactPoint: object
ContactPoint
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
fixedCount: object
Count
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
fixedDataRequirement: object
DataRequirement
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
fixedDate: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedDecimal: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedDistance: object
Distance
A length - a value with a unit that is a physical distance.
-
fixedDosage: object
Dosage
Indicates how the medication is/was taken or should be taken by the patient.
-
fixedDuration: object
Duration
A length of time.
-
fixedExpression: object
Expression
A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.
-
fixedExtendedContactDetail: object
ExtendedContactDetail
Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.
-
fixedHumanName: object
HumanName
A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.
-
fixedId: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedIdentifier: object
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
fixedInstant: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedInteger: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedInteger64: string
Pattern:
^[0]|[-+]?[1-9][0-9]*$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedMarkdown: string
Pattern:
^^[\s\S]+$$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedMeta: object
Meta
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
-
fixedMoney: object
Money
An amount of economic utility in some recognized currency.
-
fixedOid: string
Pattern:
^urn:oid:[0-2](\.(0|[1-9][0-9]*))+$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedParameterDefinition: object
ParameterDefinition
The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
-
fixedPeriod: object
Period
A time period defined by a start and end date and optionally time.
-
fixedPositiveInt: number
Pattern:
^[1-9][0-9]*$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
fixedRange: object
Range
A set of ordered Quantities defined by a low and high limit.
-
fixedRatio: object
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
fixedRatioRange: object
RatioRange
A range of ratios expressed as a low and high numerator and a denominator.
-
fixedReference: object
Reference
A reference from one resource to another.
-
fixedRelatedArtifact: object
RelatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
fixedSampledData: object
SampledData
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
-
fixedSignature: object
Signature
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
-
fixedString: string
Pattern:
^^[\s\S]+$$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedTiming: object
Timing
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
fixedTriggerDefinition: object
TriggerDefinition
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
-
fixedUnsignedInt: number
Pattern:
^[0]|([1-9][0-9]*)$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedUri: string
Pattern:
^\S*$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedUrl: string
Pattern:
^\S*$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
fixedUsageContext: object
UsageContext
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
-
fixedUuid: string
Pattern:
^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Specifies a value that SHALL be exactly the value for this element in the instance, if present. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. -
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
isModifier: boolean
Pattern:
^true|false$
Value of "true" or "false" -
isModifierReason: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
isSummary: boolean
Pattern:
^true|false$
Value of "true" or "false" -
label: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
mapping: array
mapping
Identifies a concept from an external specification that roughly corresponds to this element.
-
max: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
maxLength: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
A whole number -
maxValueDate: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
maxValueDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
maxValueDecimal: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
maxValueInstant: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
maxValueInteger: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
maxValueInteger64: string
Pattern:
^[0]|[-+]?[1-9][0-9]*$
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
maxValuePositiveInt: number
Pattern:
^[1-9][0-9]*$
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
maxValueQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
maxValueTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
maxValueUnsignedInt: number
Pattern:
^[0]|([1-9][0-9]*)$
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
meaningWhenMissing: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
min: number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0) -
minValueDate: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
minValueDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
minValueDecimal: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
minValueInstant: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
minValueInteger: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
minValueInteger64: string
Pattern:
^[0]|[-+]?[1-9][0-9]*$
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
minValuePositiveInt: number
Pattern:
^[1-9][0-9]*$
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
minValueQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
minValueTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
minValueUnsignedInt: number
Pattern:
^[0]|([1-9][0-9]*)$
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
mustHaveValue: boolean
Pattern:
^true|false$
Value of "true" or "false" -
mustSupport: boolean
Pattern:
^true|false$
Value of "true" or "false" -
orderMeaning: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
path: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
patternAddress: object
Address
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
-
patternAge: object
Age
A duration of time during which an organism (or a process) has existed.
-
patternAnnotation: object
Annotation
A text note which also contains information about who made the statement and when.
-
patternAttachment: object
Attachment
For referring to data content defined in other formats.
-
patternAvailability: object
Availability
Availability data for an {item}.
-
patternBase64Binary: string
Pattern:
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternBoolean: boolean
Pattern:
^true|false$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternCanonical: string
Pattern:
^\S*$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternCode: string
Pattern:
^[^\s]+( [^\s]+)*$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternCodeableConcept: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
patternCodeableReference: object
CodeableReference
A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
-
patternCoding: object
Coding
A reference to a code defined by a terminology system.
-
patternContactDetail: object
ContactDetail
Specifies contact information for a person or organization.
-
patternContactPoint: object
ContactPoint
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
patternCount: object
Count
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
patternDataRequirement: object
DataRequirement
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
patternDate: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternDecimal: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternDistance: object
Distance
A length - a value with a unit that is a physical distance.
-
patternDosage: object
Dosage
Indicates how the medication is/was taken or should be taken by the patient.
-
patternDuration: object
Duration
A length of time.
-
patternExpression: object
Expression
A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.
-
patternExtendedContactDetail: object
ExtendedContactDetail
Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.
-
patternHumanName: object
HumanName
A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.
-
patternId: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternIdentifier: object
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
patternInstant: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternInteger: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternInteger64: string
Pattern:
^[0]|[-+]?[1-9][0-9]*$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternMarkdown: string
Pattern:
^^[\s\S]+$$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternMeta: object
Meta
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
-
patternMoney: object
Money
An amount of economic utility in some recognized currency.
-
patternOid: string
Pattern:
^urn:oid:[0-2](\.(0|[1-9][0-9]*))+$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternParameterDefinition: object
ParameterDefinition
The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
-
patternPeriod: object
Period
A time period defined by a start and end date and optionally time.
-
patternPositiveInt: number
Pattern:
^[1-9][0-9]*$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
patternRange: object
Range
A set of ordered Quantities defined by a low and high limit.
-
patternRatio: object
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
patternRatioRange: object
RatioRange
A range of ratios expressed as a low and high numerator and a denominator.
-
patternReference: object
Reference
A reference from one resource to another.
-
patternRelatedArtifact: object
RelatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
patternSampledData: object
SampledData
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
-
patternSignature: object
Signature
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
-
patternString: string
Pattern:
^^[\s\S]+$$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternTiming: object
Timing
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
patternTriggerDefinition: object
TriggerDefinition
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
-
patternUnsignedInt: number
Pattern:
^[0]|([1-9][0-9]*)$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternUri: string
Pattern:
^\S*$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternUrl: string
Pattern:
^\S*$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
patternUsageContext: object
UsageContext
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
-
patternUuid: string
Pattern:
^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Specifies a value that each occurrence of the element in the instance SHALL follow - that is, any value in the pattern must be found in the instance, if the element has a value. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When an element within a pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value If a pattern[x] is declared on a repeating element, the pattern applies to all repetitions. If the desire is for a pattern to apply to only one element or a subset of elements, slicing must be used. See [Examples of Patterns](elementdefinition-examples.html#pattern-examples) for examples of pattern usage and the effect it will have. -
representation: array
representation
Codes that define how this element is represented in instances, when the deviation varies from the normal case. No extensions are allowed on elements with a representation of 'xmlAttr', no matter what FHIR serialization format is used.
-
requirements: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
short: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
sliceIsConstraining: boolean
Pattern:
^true|false$
Value of "true" or "false" -
sliceName: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
slicing: object
ElementDefinition_Slicing
Captures constraints on each element within the resource, profile, or extension.
-
type: array
type
The data type or resource that the value of this element is permitted to be.
-
valueAlternatives: array
valueAlternatives
Specifies a list of extensions that can appear in place of a primitive value.
Nested Schema : _alias
Type:
array
Extensions for alias
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _condition
Type:
array
Extensions for condition
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _representation
Type:
array
Extensions for representation
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : alias
Type:
array
Identifies additional names by which this element might also be known.
Show Source
-
Array of:
string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : ElementDefinition_Base
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_max: object
Element
Base definition for all elements in a resource.
-
_min: object
Element
Base definition for all elements in a resource.
-
_path: object
Element
Base definition for all elements in a resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
max: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
min: number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0) -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
path: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters
Nested Schema : ElementDefinition_Binding
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_description: object
Element
Base definition for all elements in a resource.
-
_strength: object
Element
Base definition for all elements in a resource.
-
additional: array
additional
Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.
-
description: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
strength:
Allowed Values:
[ "required", "extensible", "preferred", "example" ]
Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances. -
valueSet: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource
Nested Schema : code
Type:
array
A code that has the same meaning as the element in a particular terminology.
Show Source
-
Array of:
object Coding
A reference to a code defined by a terminology system.
Nested Schema : condition
Type:
array
A reference to an invariant that may make additional statements about the cardinality or value in the instance.
Show Source
-
Array of:
string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Nested Schema : constraint
Type:
array
Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
Show Source
-
Array of:
object ElementDefinition_Constraint
Captures constraints on each element within the resource, profile, or extension.
Nested Schema : example
Type:
array
A sample value for this element demonstrating the type of information that would typically be found in the element.
Show Source
-
Array of:
object ElementDefinition_Example
Captures constraints on each element within the resource, profile, or extension.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : mapping
Type:
array
Identifies a concept from an external specification that roughly corresponds to this element.
Show Source
-
Array of:
object ElementDefinition_Mapping
Captures constraints on each element within the resource, profile, or extension.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : representation
Type:
array
Codes that define how this element is represented in instances, when the deviation varies from the normal case. No extensions are allowed on elements with a representation of 'xmlAttr', no matter what FHIR serialization format is used.
Show Source
-
Array of:
Allowed Values:
[ "xmlAttr", "xmlText", "typeAttr", "cdaText", "xhtml" ]
Nested Schema : ElementDefinition_Slicing
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_description: object
Element
Base definition for all elements in a resource.
-
_ordered: object
Element
Base definition for all elements in a resource.
-
_rules: object
Element
Base definition for all elements in a resource.
-
description: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
discriminator: array
discriminator
Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
ordered: boolean
Pattern:
^true|false$
Value of "true" or "false" -
rules:
Allowed Values:
[ "closed", "open", "openAtEnd" ]
Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.
Nested Schema : type
Type:
array
The data type or resource that the value of this element is permitted to be.
Show Source
-
Array of:
object ElementDefinition_Type
Captures constraints on each element within the resource, profile, or extension.
Nested Schema : valueAlternatives
Type:
array
Specifies a list of extensions that can appear in place of a primitive value.
Show Source
-
Array of:
string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : additional
Type:
array
Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.
Show Source
-
Array of:
object ElementDefinition_Additional
Captures constraints on each element within the resource, profile, or extension.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : ElementDefinition_Additional
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_any: object
Element
Base definition for all elements in a resource.
-
_documentation: object
Element
Base definition for all elements in a resource.
-
_purpose: object
Element
Base definition for all elements in a resource.
-
_shortDoco: object
Element
Base definition for all elements in a resource.
-
any: boolean
Pattern:
^true|false$
Value of "true" or "false" -
documentation: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
purpose: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
shortDoco: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
usage: array
usage
Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.
-
valueSet(required): string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : usage
Type:
array
Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.
Show Source
-
Array of:
object UsageContext
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
Nested Schema : ElementDefinition_Constraint
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_expression: object
Element
Base definition for all elements in a resource.
-
_human: object
Element
Base definition for all elements in a resource.
-
_key: object
Element
Base definition for all elements in a resource.
-
_requirements: object
Element
Base definition for all elements in a resource.
-
_severity: object
Element
Base definition for all elements in a resource.
-
_suppress: object
Element
Base definition for all elements in a resource.
-
expression: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
human: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
key: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive. -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
requirements: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
severity:
Allowed Values:
[ "error", "warning" ]
Identifies the impact constraint violation has on the conformance of the instance. -
source: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource -
suppress: boolean
Pattern:
^true|false$
Value of "true" or "false"
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : ElementDefinition_Example
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_label: object
Element
Base definition for all elements in a resource.
-
_valueBase64Binary: object
Element
Base definition for all elements in a resource.
-
_valueBoolean: object
Element
Base definition for all elements in a resource.
-
_valueCanonical: object
Element
Base definition for all elements in a resource.
-
_valueCode: object
Element
Base definition for all elements in a resource.
-
_valueDate: object
Element
Base definition for all elements in a resource.
-
_valueDateTime: object
Element
Base definition for all elements in a resource.
-
_valueDecimal: object
Element
Base definition for all elements in a resource.
-
_valueId: object
Element
Base definition for all elements in a resource.
-
_valueInstant: object
Element
Base definition for all elements in a resource.
-
_valueInteger: object
Element
Base definition for all elements in a resource.
-
_valueInteger64: object
Element
Base definition for all elements in a resource.
-
_valueMarkdown: object
Element
Base definition for all elements in a resource.
-
_valueOid: object
Element
Base definition for all elements in a resource.
-
_valuePositiveInt: object
Element
Base definition for all elements in a resource.
-
_valueString: object
Element
Base definition for all elements in a resource.
-
_valueTime: object
Element
Base definition for all elements in a resource.
-
_valueUnsignedInt: object
Element
Base definition for all elements in a resource.
-
_valueUri: object
Element
Base definition for all elements in a resource.
-
_valueUrl: object
Element
Base definition for all elements in a resource.
-
_valueUuid: object
Element
Base definition for all elements in a resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
label: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
valueAddress: object
Address
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.
-
valueAge: object
Age
A duration of time during which an organism (or a process) has existed.
-
valueAnnotation: object
Annotation
A text note which also contains information about who made the statement and when.
-
valueAttachment: object
Attachment
For referring to data content defined in other formats.
-
valueAvailability: object
Availability
Availability data for an {item}.
-
valueBase64Binary: string
Pattern:
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
The actual value for the element, which must be one of the types allowed for this element. -
valueBoolean: boolean
Pattern:
^true|false$
The actual value for the element, which must be one of the types allowed for this element. -
valueCanonical: string
Pattern:
^\S*$
The actual value for the element, which must be one of the types allowed for this element. -
valueCode: string
Pattern:
^[^\s]+( [^\s]+)*$
The actual value for the element, which must be one of the types allowed for this element. -
valueCodeableConcept: object
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
valueCodeableReference: object
CodeableReference
A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
-
valueCoding: object
Coding
A reference to a code defined by a terminology system.
-
valueContactDetail: object
ContactDetail
Specifies contact information for a person or organization.
-
valueContactPoint: object
ContactPoint
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
valueCount: object
Count
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
valueDataRequirement: object
DataRequirement
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
valueDate: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
The actual value for the element, which must be one of the types allowed for this element. -
valueDateTime: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?)?)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$
The actual value for the element, which must be one of the types allowed for this element. -
valueDecimal: number
Pattern:
^-?(0|[1-9][0-9]{0,17})(\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$
The actual value for the element, which must be one of the types allowed for this element. -
valueDistance: object
Distance
A length - a value with a unit that is a physical distance.
-
valueDosage: object
Dosage
Indicates how the medication is/was taken or should be taken by the patient.
-
valueDuration: object
Duration
A length of time.
-
valueExpression: object
Expression
A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.
-
valueExtendedContactDetail: object
ExtendedContactDetail
Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.
-
valueHumanName: object
HumanName
A name, normally of a human, that can be used for other living entities (e.g. animals but not organizations) that have been assigned names by a human and may need the use of name parts or the need for usage information.
-
valueId: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
The actual value for the element, which must be one of the types allowed for this element. -
valueIdentifier: object
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
valueInstant: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
The actual value for the element, which must be one of the types allowed for this element. -
valueInteger: number
Pattern:
^[0]|[-+]?[1-9][0-9]*$
The actual value for the element, which must be one of the types allowed for this element. -
valueInteger64: string
Pattern:
^[0]|[-+]?[1-9][0-9]*$
The actual value for the element, which must be one of the types allowed for this element. -
valueMarkdown: string
Pattern:
^^[\s\S]+$$
The actual value for the element, which must be one of the types allowed for this element. -
valueMeta: object
Meta
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
-
valueMoney: object
Money
An amount of economic utility in some recognized currency.
-
valueOid: string
Pattern:
^urn:oid:[0-2](\.(0|[1-9][0-9]*))+$
The actual value for the element, which must be one of the types allowed for this element. -
valueParameterDefinition: object
ParameterDefinition
The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
-
valuePeriod: object
Period
A time period defined by a start and end date and optionally time.
-
valuePositiveInt: number
Pattern:
^[1-9][0-9]*$
The actual value for the element, which must be one of the types allowed for this element. -
valueQuantity: object
Quantity
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
valueRange: object
Range
A set of ordered Quantities defined by a low and high limit.
-
valueRatio: object
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
valueRatioRange: object
RatioRange
A range of ratios expressed as a low and high numerator and a denominator.
-
valueReference: object
Reference
A reference from one resource to another.
-
valueRelatedArtifact: object
RelatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
valueSampledData: object
SampledData
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
-
valueSignature: object
Signature
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
-
valueString: string
Pattern:
^^[\s\S]+$$
The actual value for the element, which must be one of the types allowed for this element. -
valueTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?$
The actual value for the element, which must be one of the types allowed for this element. -
valueTiming: object
Timing
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
valueTriggerDefinition: object
TriggerDefinition
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
-
valueUnsignedInt: number
Pattern:
^[0]|([1-9][0-9]*)$
The actual value for the element, which must be one of the types allowed for this element. -
valueUri: string
Pattern:
^\S*$
The actual value for the element, which must be one of the types allowed for this element. -
valueUrl: string
Pattern:
^\S*$
The actual value for the element, which must be one of the types allowed for this element. -
valueUsageContext: object
UsageContext
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
-
valueUuid: string
Pattern:
^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
The actual value for the element, which must be one of the types allowed for this element.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : ElementDefinition_Mapping
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_comment: object
Element
Base definition for all elements in a resource.
-
_identity: object
Element
Base definition for all elements in a resource.
-
_language: object
Element
Base definition for all elements in a resource.
-
_map: object
Element
Base definition for all elements in a resource.
-
comment: string
Pattern:
^^[\s\S]+$$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
identity: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive. -
language: string
Pattern:
^[^\s]+( [^\s]+)*$
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents -
map: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : discriminator
Type:
array
Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.
Show Source
-
Array of:
object ElementDefinition_Discriminator
Captures constraints on each element within the resource, profile, or extension.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : ElementDefinition_Discriminator
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_path: object
Element
Base definition for all elements in a resource.
-
_type: object
Element
Base definition for all elements in a resource.
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
path: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
type:
Allowed Values:
[ "value", "exists", "pattern", "type", "profile", "position" ]
How the element value is interpreted when discrimination is evaluated.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : ElementDefinition_Type
Type:
object
Captures constraints on each element within the resource, profile, or extension.
Show Source
-
_aggregation: array
_aggregation
Extensions for aggregation
-
_code: object
Element
Base definition for all elements in a resource.
-
_versioning: object
Element
Base definition for all elements in a resource.
-
aggregation: array
aggregation
If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.
-
code: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
profile: array
profile
Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.
-
targetProfile: array
targetProfile
Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.
-
versioning:
Allowed Values:
[ "either", "independent", "specific" ]
Whether this reference needs to be version specific or version independent, or whether either can be used.
Nested Schema : _aggregation
Type:
array
Extensions for aggregation
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : aggregation
Type:
array
If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.
Show Source
-
Array of:
Allowed Values:
[ "contained", "referenced", "bundled" ]
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : profile
Type:
array
Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.
Show Source
-
Array of:
string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource
Nested Schema : targetProfile
Type:
array
Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.
Show Source
-
Array of:
string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource
Nested Schema : StructureDefinition_Mapping
Type:
object
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
Show Source
-
_comment: object
Element
Base definition for all elements in a resource.
-
_identity: object
Element
Base definition for all elements in a resource.
-
_name: object
Element
Base definition for all elements in a resource.
-
_uri: object
Element
Base definition for all elements in a resource.
-
comment: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
id: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
identity: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive. -
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
name: string
Pattern:
^^[\s\S]+$$
A sequence of Unicode characters -
uri: string
Pattern:
^\S*$
String of characters used to identify a name or a resource
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : profile
Type:
array
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Show Source
-
Array of:
string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource
Nested Schema : security
Type:
array
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Show Source
-
Array of:
object Coding
A reference to a code defined by a terminology system.
Nested Schema : tag
Type:
array
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Show Source
-
Array of:
object Coding
A reference to a code defined by a terminology system.
Nested Schema : element
Type:
array
Captures constraints on each element within the resource.
Show Source
-
Array of:
object ElementDefinition
Captures constraints on each element within the resource, profile, or extension.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : modifierExtension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
-
Array of:
object Extension
Optional Extension Element - found in all resources.
Response
201 Response
Created