Create Contract Resource
post
oracle-fhir-server/fhir/Contract
This api lets you create a new instance of the Contract resource.
Request
There are no request parameters for this operation.
Supported Media Types
- application/fhir+json
Root Schema : schema
Type:
Show Source
object
-
_alias: array
_alias
Extensions for alias
-
_implicitRules:
Element
Base definition for all elements in a resource.
-
_instantiatesUri:
Element
Base definition for all elements in a resource.
-
_issued:
Element
Base definition for all elements in a resource.
-
_language:
Element
Base definition for all elements in a resource.
-
_name:
Element
Base definition for all elements in a resource.
-
_status:
Element
Base definition for all elements in a resource.
-
_subtitle:
Element
Base definition for all elements in a resource.
-
_title:
Element
Base definition for all elements in a resource.
-
_url:
Element
Base definition for all elements in a resource.
-
_version:
Element
Base definition for all elements in a resource.
-
alias: array
alias
Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.
-
applies:
Period
A time period defined by a start and end date and optionally time.
-
author:
Reference
A reference from one resource to another.
-
authority: array
authority
A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.
-
contained: array
contained
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
-
contentDefinition:
Contract_ContentDefinition
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
-
contentDerivative:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
domain: array
domain
Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.
-
expirationType:
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 resource. To make the use of extensions safe and manageable, 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.
-
friendly: array
friendly
The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
-
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
identifier: array
identifier
Unique identifier for this Contract or a derivative that references a Source Contract.
-
implicitRules: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
instantiatesCanonical:
Reference
A reference from one resource to another.
-
instantiatesUri: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
issued: 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]+)?(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 time zone 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. -
language: string
Pattern:
^[^\s]+(\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 -
legal: array
legal
List of Legal expressions or representations of this Contract.
-
legallyBindingAttachment:
Attachment
For referring to data content defined in other formats.
-
legallyBindingReference:
Reference
A reference from one resource to another.
-
legalState:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
meta:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
relevantHistory: array
relevantHistory
Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.
-
resourceType(required):
This is a Contract resource
-
rule: array
rule
List of Computable Policy Rule Language Representations of this Contract.
-
scope:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
signer: array
signer
Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
-
site: array
site
Sites in which the contract is complied with, exercised, or in force.
-
status: string
Pattern:
^[^\s]+(\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 -
subject: array
subject
The target entity impacted by or of interest to parties to the agreement.
-
subtitle: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
subType: array
subType
Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.
-
supportingInfo: array
supportingInfo
Information that may be needed by/relevant to the performer in their execution of this term action.
-
term: array
term
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
-
text:
Narrative
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
-
title: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
topicCodeableConcept:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
topicReference:
Reference
A reference from one resource to another.
-
type:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
url: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
version: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : _alias
Type:
array
Extensions for alias
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : alias
Type:
array
Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : Period
Type:
object
A time period defined by a start and end date and optionally time.
Show Source
-
_end:
Element
Base definition for all elements in a resource.
-
_start:
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]+)?(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 time zone 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 manageable, 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:
^[ \r\n\t\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]+)?(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 time zone 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 : Reference
Type:
object
A reference from one resource to another.
Show Source
-
_display:
Element
Base definition for all elements in a resource.
-
_reference:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
display: string
Pattern:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
identifier:
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
reference: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
type: string
Pattern:
^\S*$
String of characters used to identify a name or a resource
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, and nor can they have their own independent transaction scope.
Show Source
-
Array of:
object ResourceList
One of FHIR Resource: Ref: FHIR 4.3.0 specification.
Nested Schema : Contract_ContentDefinition
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
_copyright:
Element
Base definition for all elements in a resource.
-
_publicationDate:
Element
Base definition for all elements in a resource.
-
_publicationStatus:
Element
Base definition for all elements in a resource.
-
copyright: string
Pattern:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\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 manageable, 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).
-
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])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-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 time zone 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. -
publicationStatus: string
Pattern:
^[^\s]+(\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 -
publisher:
Reference
A reference from one resource to another.
-
subType:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
type(required):
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
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:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
text: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : domain
Type:
array
Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
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 manageable, 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 : friendly
Type:
array
The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
Show Source
-
Array of:
object Contract_Friendly
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : identifier
Type:
array
Unique identifier for this Contract or a derivative that references a Source Contract.
Show Source
-
Array of:
object Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Nested Schema : legal
Type:
array
List of Legal expressions or representations of this Contract.
Show Source
-
Array of:
object Contract_Legal
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : Attachment
Type:
object
For referring to data content defined in other formats.
Show Source
-
_contentType:
Element
Base definition for all elements in a resource.
-
_creation:
Element
Base definition for all elements in a resource.
-
_data:
Element
Base definition for all elements in a resource.
-
_hash:
Element
Base definition for all elements in a resource.
-
_language:
Element
Base definition for all elements in a resource.
-
_size:
Element
Base definition for all elements in a resource.
-
_title:
Element
Base definition for all elements in a resource.
-
_url:
Element
Base definition for all elements in a resource.
-
contentType: string
Pattern:
^[^\s]+(\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]+)?(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 time zone 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
-
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 manageable, 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.
-
hash: string
A stream of bytes
-
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
language: string
Pattern:
^[^\s]+(\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 -
size: number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0) -
title: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
url: string
Pattern:
^\S*$
A URI that is a literal reference
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:
Element
Base definition for all elements in a resource.
-
_source:
Element
Base definition for all elements in a resource.
-
_versionId:
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 manageable, 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:
^[ \r\n\t\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]+)?(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 manageable, 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 : relevantHistory
Type:
array
Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : rule
Type:
array
List of Computable Policy Rule Language Representations of this Contract.
Show Source
-
Array of:
object Contract_Rule
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : signer
Type:
array
Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
Show Source
-
Array of:
object Contract_Signer
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : site
Type:
array
Sites in which the contract is complied with, exercised, or in force.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : subject
Type:
array
The target entity impacted by or of interest to parties to the agreement.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : subType
Type:
array
Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.
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 : supportingInfo
Type:
array
Information that may be needed by/relevant to the performer in their execution of this term action.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : term
Type:
array
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
Show Source
-
Array of:
object Contract_Term
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
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:
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 manageable, 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:
^[ \r\n\t\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 : 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 manageable, 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:
Element
Base definition for all elements in a resource.
-
_valueBase64Binary:
Element
Base definition for all elements in a resource.
-
_valueBoolean:
Element
Base definition for all elements in a resource.
-
_valueCanonical:
Element
Base definition for all elements in a resource.
-
_valueCode:
Element
Base definition for all elements in a resource.
-
_valueDate:
Element
Base definition for all elements in a resource.
-
_valueDateTime:
Element
Base definition for all elements in a resource.
-
_valueDecimal:
Element
Base definition for all elements in a resource.
-
_valueId:
Element
Base definition for all elements in a resource.
-
_valueInstant:
Element
Base definition for all elements in a resource.
-
_valueInteger:
Element
Base definition for all elements in a resource.
-
_valueMarkdown:
Element
Base definition for all elements in a resource.
-
_valueOid:
Element
Base definition for all elements in a resource.
-
_valuePositiveInt:
Element
Base definition for all elements in a resource.
-
_valueString:
Element
Base definition for all elements in a resource.
-
_valueTime:
Element
Base definition for all elements in a resource.
-
_valueUnsignedInt:
Element
Base definition for all elements in a resource.
-
_valueUri:
Element
Base definition for all elements in a resource.
-
_valueUrl:
Element
Base definition for all elements in a resource.
-
_valueUuid:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
url: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
valueAddress:
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.
-
valueAge:
Age
A duration of time during which an organism (or a process) has existed.
-
valueAnnotation:
Annotation
A text note which also contains information about who made the statement and when.
-
valueAttachment:
Attachment
For referring to data content defined in other formats.
-
valueBase64Binary: string
Pattern:
^(\s*([0-9a-zA-Z\+/=]){4}\s*)+$
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[^\s]+)*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueCodeableConcept:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
valueCodeableReference:
CodeableReference
A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).
-
valueCoding:
Coding
A reference to a code defined by a terminology system.
-
valueContactDetail:
ContactDetail
Specifies contact information for a person or organization.
-
valueContactPoint:
ContactPoint
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
valueContributor:
Contributor
A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
-
valueCount:
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:
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]+)?(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-9]+)?([eE][+-]?[0-9]+)?$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueDistance:
Distance
A length - a value with a unit that is a physical distance.
-
valueDosage:
Dosage
Indicates how the medication is/was taken or should be taken by the patient.
-
valueDuration:
Duration
A length of time.
-
valueExpression:
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.
-
valueHumanName:
HumanName
A human's name with the ability to identify parts and usage.
-
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:
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]+)?(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). -
valueMarkdown: string
Pattern:
^[ \r\n\t\S]+$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueMoney:
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:
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:
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:
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:
Range
A set of ordered Quantities defined by a low and high limit.
-
valueRatio:
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
valueRatioRange:
RatioRange
A range of ratios expressed as a low and high numerator and a denominator.
-
valueReference:
Reference
A reference from one resource to another.
-
valueRelatedArtifact:
RelatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
valueSampledData:
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:
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:
^[ \r\n\t\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]+)?$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueTiming:
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:
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:
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 manageable, 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.
Show Source
-
_city:
Element
Base definition for all elements in a resource.
-
_country:
Element
Base definition for all elements in a resource.
-
_district:
Element
Base definition for all elements in a resource.
-
_line: array
_line
Extensions for line
-
_postalCode:
Element
Base definition for all elements in a resource.
-
_state:
Element
Base definition for all elements in a resource.
-
_text:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
_use:
Element
Base definition for all elements in a resource.
-
city: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
country: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
district: string
Pattern:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\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:
Period
A time period defined by a start and end date and optionally time.
-
postalCode: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
state: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
text: string
Pattern:
^[ \r\n\t\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:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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:
Element
Base definition for all elements in a resource.
-
_text:
Element
Base definition for all elements in a resource.
-
_time:
Element
Base definition for all elements in a resource.
-
authorReference:
Reference
A reference from one resource to another.
-
authorString: string
Pattern:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
text: string
Pattern:
^[ \r\n\t\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]+)?(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 time zone 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 : 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:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
reference:
Reference
A reference from one resource to another.
Nested Schema : Coding
Type:
object
A reference to a code defined by a terminology system.
Show Source
-
_code:
Element
Base definition for all elements in a resource.
-
_display:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_userSelected:
Element
Base definition for all elements in a resource.
-
_version:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : ContactDetail
Type:
object
Specifies contact information for a person or organization.
Show Source
-
_name:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
name: string
Pattern:
^[ \r\n\t\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:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_use:
Element
Base definition for all elements in a resource.
-
_value:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
period:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : Contributor
Type:
object
A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
Show Source
-
_name:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
contact: array
contact
Contact details to assist a user in finding and communicating with the contributor.
-
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
name: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
type:
Allowed Values:
[ "author", "editor", "reviewer", "endorser" ]
The type of contributor.
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:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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:
Element
Base definition for all elements in a resource.
-
_mustSupport: array
_mustSupport
Extensions for mustSupport
-
_type:
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 manageable, 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:
^[ \r\n\t\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 resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
-
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:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
subjectReference:
Reference
A reference from one resource to another.
-
type: string
Pattern:
^[^\s]+(\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 : Distance
Type:
object
A length - a value with a unit that is a physical distance.
Show Source
-
_code:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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
-
_asNeededBoolean:
Element
Base definition for all elements in a resource.
-
_patientInstruction:
Element
Base definition for all elements in a resource.
-
_sequence:
Element
Base definition for all elements in a resource.
-
_text:
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").
-
asNeededBoolean: boolean
Pattern:
^true|false$
Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). -
asNeededCodeableConcept:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
doseAndRate: array
doseAndRate
The amount of medication 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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
maxDosePerAdministration:
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:
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:
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
method:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
route:
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:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
timing:
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:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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:
Element
Base definition for all elements in a resource.
-
_expression:
Element
Base definition for all elements in a resource.
-
_language:
Element
Base definition for all elements in a resource.
-
_name:
Element
Base definition for all elements in a resource.
-
_reference:
Element
Base definition for all elements in a resource.
-
description: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
expression: string
Pattern:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
language:
Allowed Values:
[ "text/cql", "text/fhirpath", "application/x-fhir-query", "text/cql-identifier", "text/cql-expression" ]
The media type of the language for the expression. -
name: 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. -
reference: string
Pattern:
^\S*$
String of characters used to identify a name or a resource
Nested Schema : HumanName
Type:
object
A human's name with the ability to identify parts and usage.
Show Source
-
_family:
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:
Element
Base definition for all elements in a resource.
-
_use:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
given: array
given
Given name.
-
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
period:
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:
^[ \r\n\t\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:
Element
Base definition for all elements in a resource.
-
_use:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
assigner:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
period:
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:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : Money
Type:
object
An amount of economic utility in some recognized currency.
Show Source
-
_currency:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
currency: string
Pattern:
^[^\s]+(\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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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:
Element
Base definition for all elements in a resource.
-
_max:
Element
Base definition for all elements in a resource.
-
_min:
Element
Base definition for all elements in a resource.
-
_name:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
_use:
Element
Base definition for all elements in a resource.
-
documentation: string
Pattern:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
max: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
min: number
Pattern:
^-?([0]|([1-9][0-9]*))$
A whole number -
name: string
Pattern:
^[^\s]+(\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[^\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[^\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 : 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:
Element
Base definition for all elements in a resource.
-
_comparator:
Element
Base definition for all elements in a resource.
-
_system:
Element
Base definition for all elements in a resource.
-
_unit:
Element
Base definition for all elements in a resource.
-
_value:
Element
Base definition for all elements in a resource.
-
code: string
Pattern:
^[^\s]+(\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:
[ "<", "<=", ">=", ">" ]
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
system: string
Pattern:
^\S*$
String of characters used to identify a name or a resource -
unit: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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 manageable, 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:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
low:
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:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
numerator:
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:
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 manageable, 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:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
lowNumerator:
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 : RelatedArtifact
Type:
object
Related artifacts such as additional documentation, justification, or bibliographic references.
Show Source
-
_citation:
Element
Base definition for all elements in a resource.
-
_display:
Element
Base definition for all elements in a resource.
-
_label:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
_url:
Element
Base definition for all elements in a resource.
-
citation: string
Pattern:
^[ \r\n\t\S]+$
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
display: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
document:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
label: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
resource: string
Pattern:
^\S*$
A URI that is a reference to a canonical URL on a FHIR resource -
type:
Allowed Values:
[ "documentation", "justification", "citation", "predecessor", "successor", "derived-from", "depends-on", "composed-of" ]
The type of relationship to the related artifact. -
url: string
Pattern:
^\S*$
A URI that is a literal reference
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:
Element
Base definition for all elements in a resource.
-
_dimensions:
Element
Base definition for all elements in a resource.
-
_factor:
Element
Base definition for all elements in a resource.
-
_lowerLimit:
Element
Base definition for all elements in a resource.
-
_period:
Element
Base definition for all elements in a resource.
-
_upperLimit:
Element
Base definition for all elements in a resource.
-
data: string
Pattern:
^[ \r\n\t\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 manageable, 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-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
lowerLimit: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
origin(required):
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.
-
period: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
upperLimit: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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:
Element
Base definition for all elements in a resource.
-
_sigFormat:
Element
Base definition for all elements in a resource.
-
_targetFormat:
Element
Base definition for all elements in a resource.
-
_when:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
onBehalfOf:
Reference
A reference from one resource to another.
-
sigFormat: string
Pattern:
^[^\s]+(\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[^\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(required): 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]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$
An instant in time - known at least to the second -
who(required):
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:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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:
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:
Element
Base definition for all elements in a resource.
-
_timingDate:
Element
Base definition for all elements in a resource.
-
_timingDateTime:
Element
Base definition for all elements in a resource.
-
_type:
Element
Base definition for all elements in a resource.
-
condition:
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
name: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
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]+)?(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:
Reference
A reference from one resource to another.
-
timingTiming:
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):
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
valueCodeableConcept:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
valueQuantity:
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:
Range
A set of ordered Quantities defined by a low and high limit.
-
valueReference:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 : contact
Type:
array
Contact details to assist a user in finding and communicating with the contributor.
Show Source
-
Array of:
object ContactDetail
Specifies contact information for a person or organization.
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 manageable, 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 manageable, 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 manageable, 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 resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\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 : 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:
Element
Base definition for all elements in a resource.
-
_searchParam:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
searchParam: string
Pattern:
^[ \r\n\t\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 manageable, 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 manageable, 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:
Element
Base definition for all elements in a resource.
-
_searchParam:
Element
Base definition for all elements in a resource.
-
_valueDateTime:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
searchParam: string
Pattern:
^[ \r\n\t\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]+)?(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:
Duration
A length of time.
-
valuePeriod:
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 manageable, 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 manageable, 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:
Element
Base definition for all elements in a resource.
-
_path:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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:
^[ \r\n\t\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 manageable, 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 manageable, 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 manageable, 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 : doseAndRate
Type:
array
The amount of medication 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 manageable, 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 manageable, 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:
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:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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:
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:
Range
A set of ordered Quantities defined by a low and high limit.
-
rateRatio:
Ratio
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
type:
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 manageable, 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 manageable, 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 manageable, 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 manageable, 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
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 manageable, 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:
^[ \r\n\t\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:
^[ \r\n\t\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:
^[ \r\n\t\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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 manageable, 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]+)?(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 time zone 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 manageable, 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 manageable, 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:
Element
Base definition for all elements in a resource.
-
_countMax:
Element
Base definition for all elements in a resource.
-
_dayOfWeek: array
_dayOfWeek
Extensions for dayOfWeek
-
_duration:
Element
Base definition for all elements in a resource.
-
_durationMax:
Element
Base definition for all elements in a resource.
-
_durationUnit:
Element
Base definition for all elements in a resource.
-
_frequency:
Element
Base definition for all elements in a resource.
-
_frequencyMax:
Element
Base definition for all elements in a resource.
-
_offset:
Element
Base definition for all elements in a resource.
-
_period:
Element
Base definition for all elements in a resource.
-
_periodMax:
Element
Base definition for all elements in a resource.
-
_periodUnit:
Element
Base definition for all elements in a resource.
-
_timeOfDay: array
_timeOfDay
Extensions for timeOfDay
-
_when: array
_when
Extensions for when
-
boundsDuration:
Duration
A length of time.
-
boundsPeriod:
Period
A time period defined by a start and end date and optionally time.
-
boundsRange:
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-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
durationMax: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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. -
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 manageable, 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:
^[ \r\n\t\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 manageable, 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-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
periodMax: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-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. -
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[^\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 manageable, 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 manageable, 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]+)?$
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", "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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 4.3.0 specification.
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 manageable, 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 manageable, 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 manageable, 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 : Contract_Friendly
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
contentAttachment:
Attachment
For referring to data content defined in other formats.
-
contentReference:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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 manageable, 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 manageable, 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 : Contract_Legal
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
contentAttachment:
Attachment
For referring to data content defined in other formats.
-
contentReference:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 manageable, 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 : Contract_Rule
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
contentAttachment:
Attachment
For referring to data content defined in other formats.
-
contentReference:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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 manageable, 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 manageable, 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 : Contract_Signer
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
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 manageable, 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:
^[ \r\n\t\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 manageable, 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).
-
party(required):
Reference
A reference from one resource to another.
-
signature(required): array
signature
Legally binding Contract DSIG signature contents in Base64.
-
type(required):
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 manageable, 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 manageable, 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 : signature
Type:
array
Legally binding Contract DSIG signature contents in Base64.
Show Source
-
Array of:
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.
Nested Schema : Contract_Term
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
_issued:
Element
Base definition for all elements in a resource.
-
_text:
Element
Base definition for all elements in a resource.
-
action: array
action
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
-
applies:
Period
A time period defined by a start and end date and optionally time.
-
asset: array
asset
Contract Term Asset List.
-
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 manageable, 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.
-
group: array
group
Nested group of Contract Provisions.
-
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
identifier:
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
issued: 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]+)?(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 time zone 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. -
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 manageable, 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).
-
offer(required):
Contract_Offer
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
-
securityLabel: array
securityLabel
Security labels that protect the handling of information about the term and its elements, which may be specifically identified..
-
subType:
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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
topicCodeableConcept:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
topicReference:
Reference
A reference from one resource to another.
-
type:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Nested Schema : action
Type:
array
An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
Show Source
-
Array of:
object Contract_Action
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : asset
Type:
array
Contract Term Asset List.
Show Source
-
Array of:
object Contract_Asset
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
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 manageable, 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 : group
Type:
array
Nested group of Contract Provisions.
Show Source
-
Array of:
object Contract_Term
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
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 manageable, 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 : Contract_Offer
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
_linkId: array
_linkId
Extensions for linkId
-
_securityLabelNumber: array
_securityLabelNumber
Extensions for securityLabelNumber
-
_text:
Element
Base definition for all elements in a resource.
-
answer: array
answer
Response to offer text.
-
decision:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
decisionMode: array
decisionMode
How the decision about a Contract was conveyed.
-
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
identifier: array
identifier
Unique identifier for this particular Contract Provision.
-
linkId: array
linkId
The id of the clause or question text of the offer in the referenced questionnaire/response.
-
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 manageable, 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).
-
party: array
party
Offer Recipient.
-
securityLabelNumber: array
securityLabelNumber
Security labels that protects the offer.
-
text: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
topic:
Reference
A reference from one resource to another.
-
type:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Nested Schema : securityLabel
Type:
array
Security labels that protect the handling of information about the term and its elements, which may be specifically identified..
Show Source
-
Array of:
object Contract_SecurityLabel
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : Contract_Action
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
_contextLinkId: array
_contextLinkId
Extensions for contextLinkId
-
_doNotPerform:
Element
Base definition for all elements in a resource.
-
_linkId: array
_linkId
Extensions for linkId
-
_occurrenceDateTime:
Element
Base definition for all elements in a resource.
-
_performerLinkId: array
_performerLinkId
Extensions for performerLinkId
-
_reason: array
_reason
Extensions for reason
-
_reasonLinkId: array
_reasonLinkId
Extensions for reasonLinkId
-
_requesterLinkId: array
_requesterLinkId
Extensions for requesterLinkId
-
_securityLabelNumber: array
_securityLabelNumber
Extensions for securityLabelNumber
-
context:
Reference
A reference from one resource to another.
-
contextLinkId: array
contextLinkId
Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
-
doNotPerform: 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 element. To make the use of extensions safe and manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
intent(required):
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
linkId: array
linkId
Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.
-
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 manageable, 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).
-
note: array
note
Comments made about the term action made by the requester, performer, subject or other participants.
-
occurrenceDateTime: 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]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$
When action happens. -
occurrencePeriod:
Period
A time period defined by a start and end date and optionally time.
-
occurrenceTiming:
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.
-
performer:
Reference
A reference from one resource to another.
-
performerLinkId: array
performerLinkId
Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
-
performerRole:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
performerType: array
performerType
The type of individual that is desired or required to perform or not perform the action.
-
reason: array
reason
Describes why the action is to be performed or not performed in textual form.
-
reasonCode: array
reasonCode
Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.
-
reasonLinkId: array
reasonLinkId
Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
-
reasonReference: array
reasonReference
Indicates another resource whose existence justifies permitting or not permitting this action.
-
requester: array
requester
Who or what initiated the action and has responsibility for its activation.
-
requesterLinkId: array
requesterLinkId
Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
-
securityLabelNumber: array
securityLabelNumber
Security labels that protects the action.
-
status(required):
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
subject: array
subject
Entity of the action.
-
type(required):
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
Nested Schema : _contextLinkId
Type:
array
Extensions for contextLinkId
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _linkId
Type:
array
Extensions for linkId
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _performerLinkId
Type:
array
Extensions for performerLinkId
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _reason
Type:
array
Extensions for reason
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _reasonLinkId
Type:
array
Extensions for reasonLinkId
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _requesterLinkId
Type:
array
Extensions for requesterLinkId
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _securityLabelNumber
Type:
array
Extensions for securityLabelNumber
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : contextLinkId
Type:
array
Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\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 manageable, 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 : linkId
Type:
array
Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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 manageable, 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 : note
Type:
array
Comments made about the term action made by the requester, performer, subject or other participants.
Show Source
-
Array of:
object Annotation
A text note which also contains information about who made the statement and when.
Nested Schema : performerLinkId
Type:
array
Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : performerType
Type:
array
The type of individual that is desired or required to perform or not perform the action.
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 : reason
Type:
array
Describes why the action is to be performed or not performed in textual form.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : reasonCode
Type:
array
Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.
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 : reasonLinkId
Type:
array
Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : reasonReference
Type:
array
Indicates another resource whose existence justifies permitting or not permitting this action.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : requester
Type:
array
Who or what initiated the action and has responsibility for its activation.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : requesterLinkId
Type:
array
Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : securityLabelNumber
Type:
array
Security labels that protects the action.
Show Source
-
Array of:
number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0)
Nested Schema : subject
Type:
array
Entity of the action.
Show Source
-
Array of:
object Contract_Subject
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : Contract_Subject
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
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 manageable, 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:
^[ \r\n\t\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 manageable, 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).
-
reference(required): array
reference
The entity the action is performed or not performed on or for.
-
role:
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 manageable, 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 manageable, 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 : reference
Type:
array
The entity the action is performed or not performed on or for.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : Contract_Asset
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
_condition:
Element
Base definition for all elements in a resource.
-
_linkId: array
_linkId
Extensions for linkId
-
_securityLabelNumber: array
_securityLabelNumber
Extensions for securityLabelNumber
-
_text:
Element
Base definition for all elements in a resource.
-
answer: array
answer
Response to assets.
-
condition: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
context: array
context
Circumstance of the asset.
-
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 manageable, 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:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
linkId: array
linkId
Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.
-
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 manageable, 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).
-
period: array
period
Asset relevant contractual time period.
-
periodType: array
periodType
Type of Asset availability for use or ownership.
-
relationship:
Coding
A reference to a code defined by a terminology system.
-
scope:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
securityLabelNumber: array
securityLabelNumber
Security labels that protects the asset.
-
subtype: array
subtype
May be a subtype or part of an offered asset.
-
text: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
type: array
type
Target entity type about which the term may be concerned.
-
typeReference: array
typeReference
Associated entities.
-
usePeriod: array
usePeriod
Time period of asset use.
-
valuedItem: array
valuedItem
Contract Valued Item List.
Nested Schema : _linkId
Type:
array
Extensions for linkId
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _securityLabelNumber
Type:
array
Extensions for securityLabelNumber
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : answer
Type:
array
Response to assets.
Show Source
-
Array of:
object Contract_Answer
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : context
Type:
array
Circumstance of the asset.
Show Source
-
Array of:
object Contract_Context
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
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 manageable, 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 : linkId
Type:
array
Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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 manageable, 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 : period
Type:
array
Asset relevant contractual time period.
Show Source
-
Array of:
object Period
A time period defined by a start and end date and optionally time.
Nested Schema : periodType
Type:
array
Type of Asset availability for use or ownership.
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 : securityLabelNumber
Type:
array
Security labels that protects the asset.
Show Source
-
Array of:
number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0)
Nested Schema : subtype
Type:
array
May be a subtype or part of an offered asset.
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 : type
Type:
array
Target entity type about which the term may be concerned.
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 : typeReference
Type:
array
Associated entities.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : usePeriod
Type:
array
Time period of asset use.
Show Source
-
Array of:
object Period
A time period defined by a start and end date and optionally time.
Nested Schema : valuedItem
Type:
array
Contract Valued Item List.
Show Source
-
Array of:
object Contract_ValuedItem
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : Contract_Answer
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
_valueBoolean:
Element
Base definition for all elements in a resource.
-
_valueDate:
Element
Base definition for all elements in a resource.
-
_valueDateTime:
Element
Base definition for all elements in a resource.
-
_valueDecimal:
Element
Base definition for all elements in a resource.
-
_valueInteger:
Element
Base definition for all elements in a resource.
-
_valueString:
Element
Base definition for all elements in a resource.
-
_valueTime:
Element
Base definition for all elements in a resource.
-
_valueUri:
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 manageable, 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:
^[ \r\n\t\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 manageable, 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).
-
valueAttachment:
Attachment
For referring to data content defined in other formats.
-
valueBoolean: boolean
Pattern:
^true|false$
Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. -
valueCoding:
Coding
A reference to a code defined by a terminology system.
-
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]))?)?$
Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. -
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]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$
Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. -
valueDecimal: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. -
valueInteger: number
Pattern:
^-?([0]|([1-9][0-9]*))$
Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. -
valueQuantity:
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.
-
valueReference:
Reference
A reference from one resource to another.
-
valueString: string
Pattern:
^[ \r\n\t\S]+$
Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. -
valueTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?$
Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research. -
valueUri: string
Pattern:
^\S*$
Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
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 manageable, 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 manageable, 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 : Contract_Context
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
_text:
Element
Base definition for all elements in a resource.
-
code: array
code
Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.
-
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 manageable, 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:
^[ \r\n\t\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 manageable, 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).
-
reference:
Reference
A reference from one resource to another.
-
text: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
Nested Schema : code
Type:
array
Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.
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 manageable, 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 manageable, 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 : Contract_ValuedItem
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
_effectiveTime:
Element
Base definition for all elements in a resource.
-
_factor:
Element
Base definition for all elements in a resource.
-
_linkId: array
_linkId
Extensions for linkId
-
_payment:
Element
Base definition for all elements in a resource.
-
_paymentDate:
Element
Base definition for all elements in a resource.
-
_points:
Element
Base definition for all elements in a resource.
-
_securityLabelNumber: array
_securityLabelNumber
Extensions for securityLabelNumber
-
effectiveTime: 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]+)?(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 time zone 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. -
entityCodeableConcept:
CodeableConcept
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
entityReference:
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 manageable, 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-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
id: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
identifier:
Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
linkId: array
linkId
Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.
-
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 manageable, 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).
-
net:
Money
An amount of economic utility in some recognized currency.
-
payment: string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters -
paymentDate: 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]+)?(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 time zone 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. -
points: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
A rational number with implicit precision -
quantity:
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.
-
recipient:
Reference
A reference from one resource to another.
-
responsible:
Reference
A reference from one resource to another.
-
securityLabelNumber: array
securityLabelNumber
A set of security labels that define which terms are controlled by this condition.
-
unitPrice:
Money
An amount of economic utility in some recognized currency.
Nested Schema : _linkId
Type:
array
Extensions for linkId
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _securityLabelNumber
Type:
array
Extensions for securityLabelNumber
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 manageable, 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 : linkId
Type:
array
Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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 manageable, 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 : securityLabelNumber
Type:
array
A set of security labels that define which terms are controlled by this condition.
Show Source
-
Array of:
number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0)
Nested Schema : _linkId
Type:
array
Extensions for linkId
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : _securityLabelNumber
Type:
array
Extensions for securityLabelNumber
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : answer
Type:
array
Response to offer text.
Show Source
-
Array of:
object Contract_Answer
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : decisionMode
Type:
array
How the decision about a Contract was conveyed.
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 manageable, 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
Unique identifier for this particular Contract Provision.
Show Source
-
Array of:
object Identifier
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Nested Schema : linkId
Type:
array
The id of the clause or question text of the offer in the referenced questionnaire/response.
Show Source
-
Array of:
string
Pattern:
^[ \r\n\t\S]+$
A sequence of Unicode characters
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 manageable, 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 : party
Type:
array
Offer Recipient.
Show Source
-
Array of:
object Contract_Party
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Nested Schema : securityLabelNumber
Type:
array
Security labels that protects the offer.
Show Source
-
Array of:
number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0)
Nested Schema : Contract_Party
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
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 manageable, 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:
^[ \r\n\t\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 manageable, 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).
-
reference(required): array
reference
Participant in the offer.
-
role(required):
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 manageable, 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 manageable, 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 : reference
Type:
array
Participant in the offer.
Show Source
-
Array of:
object Reference
A reference from one resource to another.
Nested Schema : Contract_SecurityLabel
Type:
object
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
Show Source
-
_number: array
_number
Extensions for number
-
category: array
category
Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.
-
classification(required):
Coding
A reference to a code defined by a terminology system.
-
control: array
control
Security label privacy tag that species the manner in which term and/or term elements are to be protected.
-
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 manageable, 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:
^[ \r\n\t\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 manageable, 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).
-
number: array
number
Number used to link this term or term element to the applicable Security Label.
Nested Schema : _number
Type:
array
Extensions for number
Show Source
-
Array of:
object Element
Base definition for all elements in a resource.
Nested Schema : category
Type:
array
Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.
Show Source
-
Array of:
object Coding
A reference to a code defined by a terminology system.
Nested Schema : control
Type:
array
Security label privacy tag that species the manner in which term and/or term elements are to be protected.
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 manageable, 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 manageable, 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 : number
Type:
array
Number used to link this term or term element to the applicable Security Label.
Show Source
-
Array of:
number
Pattern:
^[0]|([1-9][0-9]*)$
An integer with a value that is not negative (e.g. >= 0)
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 manageable, 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