Update Observation Resource
put
/oracle-fhir-server/fhir/Observation/{id}
Update an existing Observation instance, or create using a client-assigned ID
Request
Path Parameters
-
id(required): string
The resource IDExample:
123
Supported Media Types
- application/fhir+json
Root Schema : schema
Type:
Show Source
object
-
_effectiveDateTime: object
Element
-
_effectiveInstant: object
Element
-
_implicitRules: object
Element
-
_issued: object
Element
-
_language: object
Element
-
_status: object
Element
-
_valueBoolean: object
Element
-
_valueDateTime: object
Element
-
_valueInteger: object
Element
-
_valueString: object
Element
-
_valueTime: object
Element
-
basedOn: array
basedOn
A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
-
bodySite: object
CodeableConcept
-
category: array
category
A code that classifies the general type of observation being made.
-
code(required): object
CodeableConcept
-
component: array
component
Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
-
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.
-
dataAbsentReason: object
CodeableConcept
-
derivedFrom: array
derivedFrom
The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
-
device: object
Reference
-
effectiveDateTime: 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 time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. -
effectiveInstant: 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 time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. -
effectivePeriod: object
Period
-
effectiveTiming: object
Timing
-
encounter: object
Reference
-
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.
-
focus: array
focus
The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
-
hasMember: array
hasMember
This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
-
id: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
-
identifier: array
identifier
A unique identifier assigned to this observation.
-
implicitRules: string
Pattern:
^\S*$
-
interpretation: array
interpretation
A categorical assessment of an observation value. For example, high, low, normal.
-
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))$
-
language: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
meta: object
Meta
-
method: object
CodeableConcept
-
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).
-
note: array
note
Comments about the observation or the results.
-
partOf: array
partOf
A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
-
performer: array
performer
Who was responsible for asserting the observed value as "true".
-
referenceRange: array
referenceRange
Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.
-
resourceType(required):
This is a Observation resource
-
specimen: object
Reference
-
status: string
Allowed Values:
[ "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", "unknown" ]
The status of the result value. -
subject: object
Reference
-
text: object
Narrative
-
valueBoolean: boolean
Pattern:
^true|false$
The information determined as a result of making the observation, if the information has a simple value. -
valueCodeableConcept: object
CodeableConcept
-
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 information determined as a result of making the observation, if the information has a simple value. -
valueInteger: number
Pattern:
^-?([0]|([1-9][0-9]*))$
The information determined as a result of making the observation, if the information has a simple value. -
valuePeriod: object
Period
-
valueQuantity: object
Quantity
-
valueRange: object
Range
-
valueRatio: object
Ratio
-
valueSampledData: object
SampledData
-
valueString: string
Pattern:
^[ \r\n\t\S]+$
The information determined as a result of making the observation, if the information has a simple value. -
valueTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?$
The information determined as a result of making the observation, if the information has a simple value.
Nested Schema : Element
Type:
Show Source
object
-
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]+$
Nested Schema : basedOn
Type:
array
A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
Show Source
Nested Schema : CodeableConcept
Type:
Show Source
object
-
_text: object
Element
-
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]+$
-
text: string
Pattern:
^[ \r\n\t\S]+$
Nested Schema : category
Type:
array
A code that classifies the general type of observation being made.
Show Source
Nested Schema : component
Type:
array
Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
Show Source
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.0.1 specification.
Nested Schema : derivedFrom
Type:
array
The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
Show Source
Nested Schema : Reference
Type:
Show Source
object
-
_display: object
Element
-
_reference: object
Element
-
_type: object
Element
-
display: string
Pattern:
^[ \r\n\t\S]+$
-
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]+$
-
identifier: object
Identifier
-
reference: string
Pattern:
^[ \r\n\t\S]+$
-
type: string
Pattern:
^\S*$
Nested Schema : Period
Type:
Show Source
object
-
_end: object
Element
-
_start: object
Element
-
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)))?)?)?$
-
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]+$
-
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)))?)?)?$
Nested Schema : Timing
Type:
Show Source
object
-
_event: array
_event
Extensions for event
-
code: object
CodeableConcept
-
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]+$
-
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: object
Timing_Repeat
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
Nested Schema : focus
Type:
array
The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
Show Source
Nested Schema : hasMember
Type:
array
This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
Show Source
Nested Schema : identifier
Type:
array
A unique identifier assigned to this observation.
Show Source
Nested Schema : interpretation
Type:
array
A categorical assessment of an observation value. For example, high, low, normal.
Show Source
Nested Schema : Meta
Type:
Show Source
object
-
_lastUpdated: object
Element
-
_source: object
Element
-
_versionId: object
Element
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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]+$
-
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))$
-
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*$
-
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}$
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
Nested Schema : partOf
Type:
array
A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
Show Source
Nested Schema : performer
Type:
array
Who was responsible for asserting the observed value as "true".
Show Source
Nested Schema : referenceRange
Type:
array
Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.
Show Source
Nested Schema : Narrative
Type:
Show Source
object
-
_status: object
Element
-
div(required):
-
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]+$
-
status: string
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 : Quantity
Type:
Show Source
object
-
_code: object
Element
-
_comparator: object
Element
-
_system: object
Element
-
_unit: object
Element
-
_value: object
Element
-
code: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
comparator: string
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]+$
-
system: string
Pattern:
^\S*$
-
unit: string
Pattern:
^[ \r\n\t\S]+$
-
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
Nested Schema : Range
Type:
Show Source
object
-
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: object
Quantity
-
id: string
Pattern:
^[ \r\n\t\S]+$
-
low: object
Quantity
Nested Schema : Ratio
Type:
Show Source
object
-
denominator: object
Quantity
-
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]+$
-
numerator: object
Quantity
Nested Schema : SampledData
Type:
Show Source
object
-
_data: object
Element
-
_dimensions: object
Element
-
_factor: object
Element
-
_lowerLimit: object
Element
-
_period: object
Element
-
_upperLimit: object
Element
-
data: string
Pattern:
^[ \r\n\t\S]+$
-
dimensions: number
Pattern:
^[1-9][0-9]*$
-
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]+)?$
-
id: string
Pattern:
^[ \r\n\t\S]+$
-
lowerLimit: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
-
origin(required): object
Quantity
-
period: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
-
upperLimit: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
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
Nested Schema : Extension
Type:
Show Source
object
-
_url: object
Element
-
_valueBase64Binary: object
Element
-
_valueBoolean: object
Element
-
_valueCanonical: object
Element
-
_valueCode: object
Element
-
_valueDate: object
Element
-
_valueDateTime: object
Element
-
_valueDecimal: object
Element
-
_valueId: object
Element
-
_valueInstant: object
Element
-
_valueInteger: object
Element
-
_valueMarkdown: object
Element
-
_valueOid: object
Element
-
_valuePositiveInt: object
Element
-
_valueString: object
Element
-
_valueTime: object
Element
-
_valueUnsignedInt: object
Element
-
_valueUri: object
Element
-
_valueUrl: object
Element
-
_valueUuid: object
Element
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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]+$
-
url: string
Pattern:
^\S*$
-
valueAddress: object
Address
-
valueAge: object
Age
-
valueAnnotation: object
Annotation
-
valueAttachment: object
Attachment
-
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: object
CodeableConcept
-
valueCoding: object
Coding
-
valueContactDetail: object
ContactDetail
-
valueContactPoint: object
ContactPoint
-
valueContributor: object
Contributor
-
valueCount: object
Count
-
valueDataRequirement: object
DataRequirement
-
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: object
Distance
-
valueDosage: object
Dosage
-
valueDuration: object
Duration
-
valueExpression: object
Expression
-
valueHumanName: object
HumanName
-
valueId: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueIdentifier: object
Identifier
-
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). -
valueMeta: object
Meta
-
valueMoney: object
Money
-
valueOid: string
Pattern:
^urn:oid:[0-2](\.(0|[1-9][0-9]*))+$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueParameterDefinition: object
ParameterDefinition
-
valuePeriod: object
Period
-
valuePositiveInt: number
Pattern:
^[1-9][0-9]*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueQuantity: object
Quantity
-
valueRange: object
Range
-
valueRatio: object
Ratio
-
valueReference: object
Reference
-
valueRelatedArtifact: object
RelatedArtifact
-
valueSampledData: object
SampledData
-
valueSignature: object
Signature
-
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: object
Timing
-
valueTriggerDefinition: object
TriggerDefinition
-
valueUnsignedInt: number
Pattern:
^[0]|([1-9][0-9]*)$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueUri: string
Pattern:
^\S*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueUrl: string
Pattern:
^\S*$
Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). -
valueUsageContext: object
UsageContext
-
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
Nested Schema : Address
Type:
Show Source
object
-
_city: object
Element
-
_country: object
Element
-
_district: object
Element
-
_line: array
_line
Extensions for line
-
_postalCode: object
Element
-
_state: object
Element
-
_text: object
Element
-
_type: object
Element
-
_use: object
Element
-
city: string
Pattern:
^[ \r\n\t\S]+$
-
country: string
Pattern:
^[ \r\n\t\S]+$
-
district: string
Pattern:
^[ \r\n\t\S]+$
-
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]+$
-
line: array
line
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
-
period: object
Period
-
postalCode: string
Pattern:
^[ \r\n\t\S]+$
-
state: string
Pattern:
^[ \r\n\t\S]+$
-
text: string
Pattern:
^[ \r\n\t\S]+$
-
type: string
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: string
Allowed Values:
[ "home", "work", "temp", "old", "billing" ]
The purpose of this address.
Nested Schema : Age
Type:
Show Source
object
-
_code: object
Element
-
_comparator: object
Element
-
_system: object
Element
-
_unit: object
Element
-
_value: object
Element
-
code: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
comparator: string
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]+$
-
system: string
Pattern:
^\S*$
-
unit: string
Pattern:
^[ \r\n\t\S]+$
-
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
Nested Schema : Annotation
Type:
Show Source
object
-
_authorString: object
Element
-
_text: object
Element
-
_time: object
Element
-
authorReference: object
Reference
-
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]+$
-
text: string
Pattern:
^[ \r\n\t\S]+$
-
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)))?)?)?$
Nested Schema : Attachment
Type:
Show Source
object
-
_contentType: object
Element
-
_creation: object
Element
-
_data: object
Element
-
_hash: object
Element
-
_language: object
Element
-
_size: object
Element
-
_title: object
Element
-
_url: object
Element
-
contentType: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
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)))?)?)?$
-
data: string
-
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
-
id: string
Pattern:
^[ \r\n\t\S]+$
-
language: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
size: number
Pattern:
^[0]|([1-9][0-9]*)$
-
title: string
Pattern:
^[ \r\n\t\S]+$
-
url: string
Pattern:
^\S*$
Nested Schema : Coding
Type:
Show Source
object
-
_code: object
Element
-
_display: object
Element
-
_system: object
Element
-
_userSelected: object
Element
-
_version: object
Element
-
code: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
display: string
Pattern:
^[ \r\n\t\S]+$
-
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]+$
-
system: string
Pattern:
^\S*$
-
userSelected: boolean
Pattern:
^true|false$
-
version: string
Pattern:
^[ \r\n\t\S]+$
Nested Schema : ContactDetail
Type:
Show Source
object
-
_name: object
Element
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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]+$
-
name: string
Pattern:
^[ \r\n\t\S]+$
-
telecom: array
telecom
The contact details for the individual (if a name was provided) or the organization.
Nested Schema : ContactPoint
Type:
Show Source
object
-
_rank: object
Element
-
_system: object
Element
-
_use: object
Element
-
_value: object
Element
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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]+$
-
period: object
Period
-
rank: number
Pattern:
^[1-9][0-9]*$
-
system: string
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: string
Allowed Values:
[ "home", "work", "temp", "old", "mobile" ]
Identifies the purpose for the contact point. -
value: string
Pattern:
^[ \r\n\t\S]+$
Nested Schema : Contributor
Type:
Show Source
object
-
_name: object
Element
-
_type: object
Element
-
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]+$
-
name: string
Pattern:
^[ \r\n\t\S]+$
-
type: string
Allowed Values:
[ "author", "editor", "reviewer", "endorser" ]
The type of contributor.
Nested Schema : Count
Type:
Show Source
object
-
_code: object
Element
-
_comparator: object
Element
-
_system: object
Element
-
_unit: object
Element
-
_value: object
Element
-
code: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
comparator: string
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]+$
-
system: string
Pattern:
^\S*$
-
unit: string
Pattern:
^[ \r\n\t\S]+$
-
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
Nested Schema : DataRequirement
Type:
Show Source
object
-
_limit: object
Element
-
_mustSupport: array
_mustSupport
Extensions for mustSupport
-
_type: object
Element
-
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]+$
-
limit: number
Pattern:
^[1-9][0-9]*$
-
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: object
CodeableConcept
-
subjectReference: object
Reference
-
type: string
Pattern:
^[^\s]+(\s[^\s]+)*$
Nested Schema : Distance
Type:
Show Source
object
-
_code: object
Element
-
_comparator: object
Element
-
_system: object
Element
-
_unit: object
Element
-
_value: object
Element
-
code: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
comparator: string
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]+$
-
system: string
Pattern:
^\S*$
-
unit: string
Pattern:
^[ \r\n\t\S]+$
-
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
Nested Schema : Dosage
Type:
Show Source
object
-
_asNeededBoolean: object
Element
-
_patientInstruction: object
Element
-
_sequence: object
Element
-
_text: object
Element
-
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: object
CodeableConcept
-
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]+$
-
maxDosePerAdministration: object
Quantity
-
maxDosePerLifetime: object
Quantity
-
maxDosePerPeriod: object
Ratio
-
method: object
CodeableConcept
-
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]+$
-
route: object
CodeableConcept
-
sequence: number
Pattern:
^-?([0]|([1-9][0-9]*))$
-
site: object
CodeableConcept
-
text: string
Pattern:
^[ \r\n\t\S]+$
-
timing: object
Timing
Nested Schema : Duration
Type:
Show Source
object
-
_code: object
Element
-
_comparator: object
Element
-
_system: object
Element
-
_unit: object
Element
-
_value: object
Element
-
code: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
comparator: string
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]+$
-
system: string
Pattern:
^\S*$
-
unit: string
Pattern:
^[ \r\n\t\S]+$
-
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
Nested Schema : Expression
Type:
Show Source
object
-
_description: object
Element
-
_expression: object
Element
-
_language: object
Element
-
_name: object
Element
-
_reference: object
Element
-
description: string
Pattern:
^[ \r\n\t\S]+$
-
expression: string
Pattern:
^[ \r\n\t\S]+$
-
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]+$
-
language: string
Allowed Values:
[ "text/cql", "text/fhirpath", "application/x-fhir-query" ]
The media type of the language for the expression. -
name: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
-
reference: string
Pattern:
^\S*$
Nested Schema : HumanName
Type:
Show Source
object
-
_family: object
Element
-
_given: array
_given
Extensions for given
-
_prefix: array
_prefix
Extensions for prefix
-
_suffix: array
_suffix
Extensions for suffix
-
_text: object
Element
-
_use: object
Element
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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]+$
-
given: array
given
Given name.
-
id: string
Pattern:
^[ \r\n\t\S]+$
-
period: object
Period
-
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]+$
-
use: string
Allowed Values:
[ "usual", "official", "temp", "nickname", "anonymous", "old", "maiden" ]
Identifies the purpose for this name.
Nested Schema : Identifier
Type:
Show Source
object
-
_system: object
Element
-
_use: object
Element
-
_value: object
Element
-
assigner: object
Reference
-
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]+$
-
period: object
Period
-
system: string
Pattern:
^\S*$
-
type: object
CodeableConcept
-
use: string
Allowed Values:
[ "usual", "official", "temp", "secondary", "old" ]
The purpose of this identifier. -
value: string
Pattern:
^[ \r\n\t\S]+$
Nested Schema : Money
Type:
Show Source
object
-
_currency: object
Element
-
_value: object
Element
-
currency: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
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]+$
-
value: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
Nested Schema : ParameterDefinition
Type:
Show Source
object
-
_documentation: object
Element
-
_max: object
Element
-
_min: object
Element
-
_name: object
Element
-
_type: object
Element
-
_use: object
Element
-
documentation: string
Pattern:
^[ \r\n\t\S]+$
-
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]+$
-
max: string
Pattern:
^[ \r\n\t\S]+$
-
min: number
Pattern:
^-?([0]|([1-9][0-9]*))$
-
name: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
profile: string
Pattern:
^\S*$
-
type: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
use: string
Pattern:
^[^\s]+(\s[^\s]+)*$
Nested Schema : RelatedArtifact
Type:
Show Source
object
-
_citation: object
Element
-
_display: object
Element
-
_label: object
Element
-
_type: object
Element
-
_url: object
Element
-
citation: string
Pattern:
^[ \r\n\t\S]+$
-
display: string
Pattern:
^[ \r\n\t\S]+$
-
document: object
Attachment
-
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]+$
-
label: string
Pattern:
^[ \r\n\t\S]+$
-
resource: string
Pattern:
^\S*$
-
type: string
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*$
Nested Schema : Signature
Type:
Show Source
object
-
_data: object
Element
-
_sigFormat: object
Element
-
_targetFormat: object
Element
-
_when: object
Element
-
data: string
-
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]+$
-
onBehalfOf: object
Reference
-
sigFormat: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
targetFormat: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
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))$
-
who(required): object
Reference
Nested Schema : TriggerDefinition
Type:
Show Source
object
-
_name: object
Element
-
_timingDate: object
Element
-
_timingDateTime: object
Element
-
_type: object
Element
-
condition: object
Expression
-
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]+$
-
name: string
Pattern:
^[ \r\n\t\S]+$
-
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: object
Reference
-
timingTiming: object
Timing
-
type: string
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:
Show Source
object
-
code(required): object
Coding
-
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]+$
-
valueCodeableConcept: object
CodeableConcept
-
valueQuantity: object
Quantity
-
valueRange: object
Range
-
valueReference: object
Reference
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
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]+$
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
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
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
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
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
Nested Schema : telecom
Type:
array
The contact details for the individual (if a name was provided) or the organization.
Show Source
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
Nested Schema : contact
Type:
array
Contact details to assist a user in finding and communicating with the contributor.
Show Source
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
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
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
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
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
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]+$
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*$
Nested Schema : DataRequirement_CodeFilter
Type:
Show Source
object
-
_path: object
Element
-
_searchParam: object
Element
-
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]+$
-
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]+$
-
searchParam: string
Pattern:
^[ \r\n\t\S]+$
-
valueSet: string
Pattern:
^\S*$
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
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
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
Nested Schema : DataRequirement_DateFilter
Type:
Show Source
object
-
_path: object
Element
-
_searchParam: object
Element
-
_valueDateTime: object
Element
-
extension: array
extension
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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]+$
-
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]+$
-
searchParam: string
Pattern:
^[ \r\n\t\S]+$
-
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: object
Duration
-
valuePeriod: object
Period
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
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
Nested Schema : DataRequirement_Sort
Type:
Show Source
object
-
_direction: object
Element
-
_path: object
Element
-
direction: string
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]+$
-
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]+$
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
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
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
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
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
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
Nested Schema : Dosage_DoseAndRate
Type:
Show Source
object
-
doseQuantity: object
Quantity
-
doseRange: object
Range
-
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]+$
-
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: object
Quantity
-
rateRange: object
Range
-
rateRatio: object
Ratio
-
type: object
CodeableConcept
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
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
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
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
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
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]+$
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]+$
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
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
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
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
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
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
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
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
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
Nested Schema : coding
Type:
array
A reference to a code defined by a terminology system.
Show Source
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
Nested Schema : Observation_Component
Type:
Show Source
object
-
_valueBoolean: object
Element
-
_valueDateTime: object
Element
-
_valueInteger: object
Element
-
_valueString: object
Element
-
_valueTime: object
Element
-
code(required): object
CodeableConcept
-
dataAbsentReason: object
CodeableConcept
-
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]+$
-
interpretation: array
interpretation
A categorical assessment of an observation value. For example, high, low, normal.
-
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).
-
referenceRange: array
referenceRange
Guidance on how to interpret the value by comparison to a normal or recommended range.
-
valueBoolean: boolean
Pattern:
^true|false$
The information determined as a result of making the observation, if the information has a simple value. -
valueCodeableConcept: object
CodeableConcept
-
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 information determined as a result of making the observation, if the information has a simple value. -
valueInteger: number
Pattern:
^-?([0]|([1-9][0-9]*))$
The information determined as a result of making the observation, if the information has a simple value. -
valuePeriod: object
Period
-
valueQuantity: object
Quantity
-
valueRange: object
Range
-
valueRatio: object
Ratio
-
valueSampledData: object
SampledData
-
valueString: string
Pattern:
^[ \r\n\t\S]+$
The information determined as a result of making the observation, if the information has a simple value. -
valueTime: string
Pattern:
^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?$
The information determined as a result of making the observation, if the information has a simple value.
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
Nested Schema : interpretation
Type:
array
A categorical assessment of an observation value. For example, high, low, normal.
Show Source
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
Nested Schema : referenceRange
Type:
array
Guidance on how to interpret the value by comparison to a normal or recommended range.
Show Source
Nested Schema : Observation_ReferenceRange
Type:
Show Source
object
-
_text: object
Element
-
age: object
Range
-
appliesTo: array
appliesTo
Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.
-
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: object
Quantity
-
id: string
Pattern:
^[ \r\n\t\S]+$
-
low: object
Quantity
-
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
-
text: string
Pattern:
^[ \r\n\t\S]+$
-
type: object
CodeableConcept
Nested Schema : appliesTo
Type:
array
Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.
Show Source
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
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
Nested Schema : ResourceList
Type:
object
One of FHIR Resource: Ref: FHIR 4.0.1 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
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
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)))?)?)?$
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
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
Nested Schema : Timing_Repeat
Type:
Show Source
object
-
_count: object
Element
-
_countMax: object
Element
-
_dayOfWeek: array
_dayOfWeek
Extensions for dayOfWeek
-
_duration: object
Element
-
_durationMax: object
Element
-
_durationUnit: object
Element
-
_frequency: object
Element
-
_frequencyMax: object
Element
-
_offset: object
Element
-
_period: object
Element
-
_periodMax: object
Element
-
_periodUnit: object
Element
-
_timeOfDay: array
_timeOfDay
Extensions for timeOfDay
-
_when: array
_when
Extensions for when
-
boundsDuration: object
Duration
-
boundsPeriod: object
Period
-
boundsRange: object
Range
-
count: number
Pattern:
^[1-9][0-9]*$
-
countMax: number
Pattern:
^[1-9][0-9]*$
-
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]+)?$
-
durationMax: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
-
durationUnit: string
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]*$
-
frequencyMax: number
Pattern:
^[1-9][0-9]*$
-
id: string
Pattern:
^[ \r\n\t\S]+$
-
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]*)$
-
period: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
-
periodMax: number
Pattern:
^-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?$
-
periodUnit: string
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
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]+)*$
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
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
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]+)?$
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:
string
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 : 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
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*$
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
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
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
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
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
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
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
Response
200 Response
Success