GET ClaimResponse Resource Bundle
get
/oracle-fhir-server/fhir/ClaimResponse
This endpoint supports the retrieval of ClaimResponse resource list.It returns Bundle of Account resource.
Request
Query Parameters
-
_content(optional): STRING
Search the contents of the resource's data using a fulltext search
-
_filter(optional): STRING
Search the contents of the resource's data using a filter
-
_has(optional): STRING
Return resources linked to by the given target
-
_id(optional): TOKEN
The ID of the resource
-
_language(optional): STRING
The language of the resource
-
_lastUpdated(optional): DATE
Only return resources which were last updated as specified by the given range
-
_profile(optional): URI
Search for resources which have the given profile
-
_security(optional): TOKEN
Search for resources which have the given security labels
-
_source(optional): URI
Search for resources which have the given source value (Resource.meta.source)
-
_tag(optional): TOKEN
Search for resources which have the given tag
-
_text(optional): STRING
Search the contents of the resource's narrative using a fulltext search
-
created(optional): DATE
The creation date
-
disposition(optional): STRING
The contents of the disposition message
-
identifier(optional): TOKEN
The identity of the ClaimResponse
-
insurer(optional): REFERENCE
The organization which generated this resource
-
outcome(optional): TOKEN
The processing outcome
-
patient(optional): REFERENCE
The subject of care
-
payment-date(optional): DATE
The expected payment date
-
request(optional): REFERENCE
The claim reference
-
requestor(optional): REFERENCE
The Provider of the claim
-
status(optional): TOKEN
The status of the ClaimResponse
-
use(optional): TOKEN
The type of claim
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/fhir+json
200 Response
Success
Nested Schema : schema
Type:
Show Source
object
-
_created: object
Element
-
_disposition: object
Element
-
_implicitRules: object
Element
-
_language: object
Element
-
_outcome: object
Element
-
_preAuthRef: object
Element
-
_status: object
Element
-
_use: object
Element
-
addItem: array
addItem
The first-tier service adjudications for payor added product or service lines.
-
adjudication: array
adjudication
The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
-
communicationRequest: array
communicationRequest
Request for additional supporting or authorizing information.
-
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.
-
created: 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)))?)?)?$
-
disposition: string
Pattern:
^[ \r\n\t\S]+$
-
error: array
error
Errors encountered during the processing of the adjudication.
-
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.
-
form: object
Attachment
-
formCode: object
CodeableConcept
-
fundsReserve: object
CodeableConcept
-
id: string
Pattern:
^[A-Za-z0-9\-\.]{1,64}$
-
identifier: array
identifier
A unique identifier assigned to this claim response.
-
implicitRules: string
Pattern:
^\S*$
-
insurance: array
insurance
Financial instruments for reimbursement for the health care products and services specified on the claim.
-
insurer(required): object
Reference
-
item: array
item
A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
-
language: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
meta: object
Meta
-
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).
-
outcome: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
patient(required): object
Reference
-
payeeType: object
CodeableConcept
-
payment: object
ClaimResponse_Payment
-
preAuthPeriod: object
Period
-
preAuthRef: string
Pattern:
^[ \r\n\t\S]+$
-
processNote: array
processNote
A note that describes or explains adjudication results in a human readable form.
-
request: object
Reference
-
requestor: object
Reference
-
resourceType(required):
This is a ClaimResponse resource
-
status: string
Pattern:
^[^\s]+(\s[^\s]+)*$
-
subType: object
CodeableConcept
-
text: object
Narrative
-
total: array
total
Categorized monetary totals for the adjudication.
-
type(required): object
CodeableConcept
-
use: string
Pattern:
^[^\s]+(\s[^\s]+)*$
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 : addItem
Type:
array
The first-tier service adjudications for payor added product or service lines.
Show Source
Nested Schema : adjudication
Type:
array
The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
Show Source
Nested Schema : communicationRequest
Type:
array
Request for additional supporting or authorizing information.
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 : error
Type:
array
Errors encountered during the processing of the adjudication.
Show Source
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 : 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 : 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 : identifier
Type:
array
A unique identifier assigned to this claim response.
Show Source
Nested Schema : insurance
Type:
array
Financial instruments for reimbursement for the health care products and services specified on the claim.
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 : item
Type:
array
A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
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 : ClaimResponse_Payment
Type:
Show Source
object
-
_date: object
Element
-
adjustment: object
Money
-
adjustmentReason: object
CodeableConcept
-
amount(required): object
Money
-
date: string
Pattern:
^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$
-
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
-
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).
-
type(required): object
CodeableConcept
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 : processNote
Type:
array
A note that describes or explains adjudication results in a human readable form.
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 : 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 : 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 : 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 : 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 : 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 : 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 : 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 : 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 : 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 : 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 : 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 : 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 : ClaimResponse_AddItem
Type:
Show Source
object
-
_detailSequence: array
_detailSequence
Extensions for detailSequence
-
_factor: object
Element
-
_itemSequence: array
_itemSequence
Extensions for itemSequence
-
_noteNumber: array
_noteNumber
Extensions for noteNumber
-
_servicedDate: object
Element
-
_subdetailSequence: array
_subdetailSequence
Extensions for subdetailSequence
-
adjudication(required): array
adjudication
The adjudication results.
-
bodySite: object
CodeableConcept
-
detail: array
detail
The second-tier service adjudications for payor added services.
-
detailSequence: array
detailSequence
The sequence number of the details within the claim item which this line is intended to replace.
-
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]+$
-
itemSequence: array
itemSequence
Claim items which this service line is intended to replace.
-
locationAddress: object
Address
-
locationCodeableConcept: object
CodeableConcept
-
locationReference: object
Reference
-
modifier: array
modifier
Item typification or modifiers codes to convey additional context for the product or service.
-
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
net: object
Money
-
noteNumber: array
noteNumber
The numbers associated with notes below which apply to the adjudication of this item.
-
productOrService(required): object
CodeableConcept
-
programCode: array
programCode
Identifies the program under which this may be recovered.
-
provider: array
provider
The providers who are authorized for the services rendered to the patient.
-
quantity: object
Quantity
-
servicedDate: 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 date or dates when the service or product was supplied, performed or completed. -
servicedPeriod: object
Period
-
subdetailSequence: array
subdetailSequence
The sequence number of the sub-details within the details within the claim item which this line is intended to replace.
-
subSite: array
subSite
A region or surface of the bodySite, e.g. limb region or tooth surface(s).
-
unitPrice: object
Money
Nested Schema : detail
Type:
array
The second-tier service adjudications for payor added services.
Show Source
Nested Schema : detailSequence
Type:
array
The sequence number of the details within the claim item which this line is intended to replace.
Show Source
-
Array of:
number
Pattern:
^[1-9][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 : itemSequence
Type:
array
Claim items which this service line is intended to replace.
Show Source
-
Array of:
number
Pattern:
^[1-9][0-9]*$
Nested Schema : modifier
Type:
array
Item typification or modifiers codes to convey additional context for the product or service.
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 : noteNumber
Type:
array
The numbers associated with notes below which apply to the adjudication of this item.
Show Source
-
Array of:
number
Pattern:
^[1-9][0-9]*$
Nested Schema : programCode
Type:
array
Identifies the program under which this may be recovered.
Show Source
Nested Schema : provider
Type:
array
The providers who are authorized for the services rendered to the patient.
Show Source
Nested Schema : subdetailSequence
Type:
array
The sequence number of the sub-details within the details within the claim item which this line is intended to replace.
Show Source
-
Array of:
number
Pattern:
^[1-9][0-9]*$
Nested Schema : subSite
Type:
array
A region or surface of the bodySite, e.g. limb region or tooth surface(s).
Show Source
Nested Schema : ClaimResponse_Adjudication
Type:
Show Source
object
-
_value: object
Element
-
amount: object
Money
-
category(required): 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]+$
-
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).
-
reason: object
CodeableConcept
-
value: 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 : 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 : ClaimResponse_Detail1
Type:
Show Source
object
-
_factor: object
Element
-
_noteNumber: array
_noteNumber
Extensions for noteNumber
-
adjudication(required): array
adjudication
The adjudication results.
-
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]+$
-
modifier: array
modifier
Item typification or modifiers codes to convey additional context for the product or service.
-
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
net: object
Money
-
noteNumber: array
noteNumber
The numbers associated with notes below which apply to the adjudication of this item.
-
productOrService(required): object
CodeableConcept
-
quantity: object
Quantity
-
subDetail: array
subDetail
The third-tier service adjudications for payor added services.
-
unitPrice: object
Money
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 : modifier
Type:
array
Item typification or modifiers codes to convey additional context for the product or service.
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 : noteNumber
Type:
array
The numbers associated with notes below which apply to the adjudication of this item.
Show Source
-
Array of:
number
Pattern:
^[1-9][0-9]*$
Nested Schema : subDetail
Type:
array
The third-tier service adjudications for payor added services.
Show Source
Nested Schema : ClaimResponse_SubDetail1
Type:
Show Source
object
-
_factor: object
Element
-
_noteNumber: array
_noteNumber
Extensions for noteNumber
-
adjudication(required): array
adjudication
The adjudication results.
-
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]+$
-
modifier: array
modifier
Item typification or modifiers codes to convey additional context for the product or service.
-
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
-
net: object
Money
-
noteNumber: array
noteNumber
The numbers associated with notes below which apply to the adjudication of this item.
-
productOrService(required): object
CodeableConcept
-
quantity: object
Quantity
-
unitPrice: object
Money
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 : modifier
Type:
array
Item typification or modifiers codes to convey additional context for the product or service.
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 : noteNumber
Type:
array
The numbers associated with notes below which apply to the adjudication of this item.
Show Source
-
Array of:
number
Pattern:
^[1-9][0-9]*$
Nested Schema : ResourceList
Type:
object
One of FHIR Resource: Ref: FHIR 4.0.1 specification.
Nested Schema : ClaimResponse_Error
Type:
Show Source
object
-
_detailSequence: object
Element
-
_itemSequence: object
Element
-
_subDetailSequence: object
Element
-
code(required): object
CodeableConcept
-
detailSequence: 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.
-
id: string
Pattern:
^[ \r\n\t\S]+$
-
itemSequence: number
Pattern:
^[1-9][0-9]*$
-
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).
-
subDetailSequence: number
Pattern:
^[1-9][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 : 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 : 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 : ClaimResponse_Insurance
Type:
Show Source
object
-
_businessArrangement: object
Element
-
_focal: object
Element
-
_sequence: object
Element
-
businessArrangement: string
Pattern:
^[ \r\n\t\S]+$
-
claimResponse: object
Reference
-
coverage(required): 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.
-
focal: boolean
Pattern:
^true|false$
-
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).
-
sequence: number
Pattern:
^[1-9][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 : 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 : ClaimResponse_Item
Type:
Show Source
object
-
_itemSequence: object
Element
-
_noteNumber: array
_noteNumber
Extensions for noteNumber
-
adjudication(required): array
adjudication
If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.
-
detail: array
detail
A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
-
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]+$
-
itemSequence: number
Pattern:
^[1-9][0-9]*$
-
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).
-
noteNumber: array
noteNumber
The numbers associated with notes below which apply to the adjudication of this item.
Nested Schema : adjudication
Type:
array
If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.
Show Source
Nested Schema : detail
Type:
array
A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
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 : noteNumber
Type:
array
The numbers associated with notes below which apply to the adjudication of this item.
Show Source
-
Array of:
number
Pattern:
^[1-9][0-9]*$
Nested Schema : ClaimResponse_Detail
Type:
Show Source
object
-
_detailSequence: object
Element
-
_noteNumber: array
_noteNumber
Extensions for noteNumber
-
adjudication(required): array
adjudication
The adjudication results.
-
detailSequence: 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.
-
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).
-
noteNumber: array
noteNumber
The numbers associated with notes below which apply to the adjudication of this item.
-
subDetail: array
subDetail
A sub-detail adjudication of a simple product or service.
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 : noteNumber
Type:
array
The numbers associated with notes below which apply to the adjudication of this item.
Show Source
-
Array of:
number
Pattern:
^[1-9][0-9]*$
Nested Schema : subDetail
Type:
array
A sub-detail adjudication of a simple product or service.
Show Source
Nested Schema : ClaimResponse_SubDetail
Type:
Show Source
object
-
_noteNumber: array
_noteNumber
Extensions for noteNumber
-
_subDetailSequence: object
Element
-
adjudication: array
adjudication
The adjudication results.
-
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).
-
noteNumber: array
noteNumber
The numbers associated with notes below which apply to the adjudication of this item.
-
subDetailSequence: number
Pattern:
^[1-9][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 : 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 : noteNumber
Type:
array
The numbers associated with notes below which apply to the adjudication of this item.
Show Source
-
Array of:
number
Pattern:
^[1-9][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 : 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 : 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 : ClaimResponse_ProcessNote
Type:
Show Source
object
-
_number: object
Element
-
_text: object
Element
-
_type: 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]+$
-
language: 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).
-
number: number
Pattern:
^[1-9][0-9]*$
-
text: string
Pattern:
^[ \r\n\t\S]+$
-
type: string
Allowed Values:
[ "display", "print", "printoper" ]
The business purpose of the note text.
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
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 : ClaimResponse_Total
Type:
Show Source
object
-
amount(required): object
Money
-
category(required): 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]+$
-
modifierExtension: array
modifierExtension
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Nested Schema : extension
Type:
array
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Show Source
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