Package google.fhir.stu3.proto

Index

Account

Auto-generated from StructureDefinition for Account, last updated 2017-04-19T07:44:43.294+10:00. Tracks balance, charges, for patient or cost center. See http://hl7.org/fhir/StructureDefinition/Account

Fields
id

Id

Logical id of this artifact

meta

Meta

Metadata about the resource

implicit_rules

Uri

A set of rules under which this content was created

language

LanguageCode

Language of the resource content

text

Narrative

Text summary of the resource, for human interpretation

contained[]

ContainedResource

Contained, inline Resources

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

identifier[]

Identifier

Account number

status

AccountStatusCode

active | inactive | entered-in-error

type

CodeableConcept

E.g. patient, expense, depreciation

name

String

Human-readable label

subject

Reference

What is account tied to?

period

Period

Transaction window

active

Period

Time window that transactions may be posted to this account

balance

Money

How much is in account?

coverage[]

Coverage

owner

Reference

Who is responsible?

description

String

Explanation of purpose/use

guarantor[]

Guarantor

Coverage

The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

coverage

Reference

The party(s) that are responsible for covering the payment of this account

priority

PositiveInt

The priority of the coverage in the context of this account

Guarantor

Responsible for the account

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

party

Reference

Responsible entity

on_hold

Boolean

Credit or other hold applied

period

Period

Guarrantee account during

AccountStatusCode

Indicates whether the account is available to be used. See http://hl7.org/fhir/ValueSet/account-status

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
INACTIVE
ENTERED_IN_ERROR

ActionCardinalityBehaviorCode

Defines behavior for an action or a group for how many times that item may be repeated See http://hl7.org/fhir/ValueSet/action-cardinality-behavior

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
SINGLE
MULTIPLE

ActionConditionKindCode

Defines the kinds of conditions that can appear on actions See http://hl7.org/fhir/ValueSet/action-condition-kind

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
APPLICABILITY
START
STOP

ActionGroupingBehaviorCode

Defines organization behavior of a group See http://hl7.org/fhir/ValueSet/action-grouping-behavior

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
VISUAL_GROUP
LOGICAL_GROUP
SENTENCE_GROUP

ActionListCode

List of allowable action which this resource can request. See http://hl7.org/fhir/ValueSet/actionlist

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
CANCEL
POLL
REPROCESS
STATUS

ActionParticipantTypeCode

The type of participant for the action See http://hl7.org/fhir/ValueSet/action-participant-type

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
PATIENT
PRACTITIONER
RELATED_PERSON

ActionPrecheckBehaviorCode

Defines selection frequency behavior for an action or group See http://hl7.org/fhir/ValueSet/action-precheck-behavior

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
YES
NO

ActionRelationshipTypeCode

Defines the types of relationships between actions See http://hl7.org/fhir/ValueSet/action-relationship-type

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
BEFORE_START
BEFORE
BEFORE_END
CONCURRENT_WITH_START
CONCURRENT
CONCURRENT_WITH_END
AFTER_START
AFTER
AFTER_END

ActionRequiredBehaviorCode

Defines requiredness behavior for selecting an action or an action group See http://hl7.org/fhir/ValueSet/action-required-behavior

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
MUST
COULD
MUST_UNLESS_DOCUMENTED

ActionSelectionBehaviorCode

Defines selection behavior of a group See http://hl7.org/fhir/ValueSet/action-selection-behavior

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
ANY
ALL
ALL_OR_NONE
EXACTLY_ONE
AT_MOST_ONE
ONE_OR_MORE

ActivityDefinition

Auto-generated from StructureDefinition for ActivityDefinition, last updated 2017-04-19T07:44:43.294+10:00. The definition of a specific activity to be taken, independent of any particular patient or context. See http://hl7.org/fhir/StructureDefinition/ActivityDefinition

Fields
id

Id

Logical id of this artifact

meta

Meta

Metadata about the resource

implicit_rules

Uri

A set of rules under which this content was created

language

LanguageCode

Language of the resource content

text

Narrative

Text summary of the resource, for human interpretation

contained[]

ContainedResource

Contained, inline Resources

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

url

Uri

Logical URI to reference this activity definition (globally unique)

identifier[]

Identifier

Additional identifier for the activity definition

version

String

Business version of the activity definition

name

String

Name for this activity definition (computer friendly)

title

String

Name for this activity definition (human friendly)

status

PublicationStatusCode

draft | active | retired | unknown

experimental

Boolean

For testing purposes, not real usage

date

DateTime

Date this was last changed

publisher

String

Name of the publisher (organization or individual)

description

Markdown

Natural language description of the activity definition

purpose

Markdown

Why this activity definition is defined

usage

String

Describes the clinical usage of the asset

approval_date

Date

When the activity definition was approved by publisher

last_review_date

Date

When the activity definition was last reviewed

effective_period

Period

When the activity definition is expected to be used

use_context[]

UsageContext

Context the content is intended to support

jurisdiction[]

CodeableConcept

Intended jurisdiction for activity definition (if applicable)

topic[]

CodeableConcept

E.g. Education, Treatment, Assessment, etc

contributor[]

Contributor

A content contributor

contact[]

ContactDetail

Contact details for the publisher

copyright

Markdown

Use and/or publishing restrictions

related_artifact[]

RelatedArtifact

Additional documentation, citations, etc

library[]

Reference

Logic used by the asset

kind

ResourceTypeCode

Kind of resource

code

CodeableConcept

Detail type of activity

timing

TimingType

location

Reference

Where it should happen

participant[]

Participant

product

Product

quantity

SimpleQuantity

How much is administered/consumed/supplied

dosage[]

Dosage

Detailed dosage instructions

body_site[]

CodeableConcept

What part of body to perform on

transform

Reference

Transform to apply the template

dynamic_value[]

DynamicValue

DynamicValue

Dynamic aspects of the definition

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

description

String

Natural language description of the dynamic value

path

String

The path to the element to be set dynamically

language

String

Language of the expression

expression

String

An expression that provides the dynamic value for the customization

Participant

Who should participate in the action

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

type

ActionParticipantTypeCode

patient | practitioner | related-person

role

CodeableConcept

E.g. Nurse, Surgeon, Parent, etc

Product

What's administered/supplied

Fields

Union field product.

product can be only one of the following:

reference

Reference

codeable_concept

CodeableConcept

TimingType

When activity is to occur

Fields

Union field timing.

timing can be only one of the following:

timing_value

Timing

date_time

DateTime

period

Period

range

Range

Address

Auto-generated from StructureDefinition for Address, last updated 2017-04-19T07:44:43.294+10:00. An address expressed using postal conventions (as opposed to GPS or other location definition formats). See http://hl7.org/fhir/StructureDefinition/Address

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

use

AddressUseCode

home | work | temp | old - purpose of this address

type

AddressTypeCode

postal | physical | both

text

String

Text representation of the address

line[]

String

Street name, number, direction & P.O. Box etc.

city

String

Name of city, town etc.

district

String

District name (aka county)

state

String

Sub-unit of country (abbreviations ok)

postal_code

String

Postal code for area

country

String

Country (e.g. can be ISO 3166 2 or 3 letter code)

period

Period

Time period when address was/is in use

AddressTypeCode

The type of an address (physical / postal) See http://hl7.org/fhir/ValueSet/address-type

Fields
value

Value

id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
POSTAL
PHYSICAL
BOTH

AddressUseCode

The use of an address See http://hl7.org/fhir/ValueSet/address-use

Fields
value

Value

id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

Value

Primitive value for code

Enums
INVALID_UNINITIALIZED
HOME
WORK
TEMP
OLD

AdministrativeGenderCode

The gender of a person used for administrative purposes. See http://hl7.org/fhir/ValueSet/administrative-gender

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
MALE
FEMALE
OTHER
UNKNOWN

AdverseEvent

Auto-generated from StructureDefinition for AdverseEvent, last updated 2017-04-19T07:44:43.294+10:00. Medical care, research study or other healthcare event causing physical injury. See http://hl7.org/fhir/StructureDefinition/AdverseEvent

Fields
id

Id

Logical id of this artifact

meta

Meta

Metadata about the resource

implicit_rules

Uri

A set of rules under which this content was created

language

LanguageCode

Language of the resource content

text

Narrative

Text summary of the resource, for human interpretation

contained[]

ContainedResource

Contained, inline Resources

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

identifier

Identifier

Business identifier for the event

category

AdverseEventCategoryCode

AE | PAE An adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not

type

CodeableConcept

actual | potential

subject

Reference

Subject or group impacted by event

date

DateTime

When the event occurred

reaction[]

Reference

Adverse Reaction Events linked to exposure to substance

location

Reference

Location where adverse event occurred

seriousness

CodeableConcept

Mild | Moderate | Severe

outcome

CodeableConcept

resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown

recorder

Reference

Who recorded the adverse event

event_participant

Reference

Who was involved in the adverse event or the potential adverse event

description

String

Description of the adverse event

suspect_entity[]

SuspectEntity

subject_medical_history[]

Reference

AdverseEvent.subjectMedicalHistory

reference_document[]

Reference

AdverseEvent.referenceDocument

study[]

Reference

AdverseEvent.study

SuspectEntity

The suspected agent causing the adverse event

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

instance

Reference

Refers to the specific entity that caused the adverse event

causality

AdverseEventCausalityCode

causality1 | causality2

causality_assessment

CodeableConcept

assess1 | assess2

causality_product_relatedness

String

AdverseEvent.suspectEntity.causalityProductRelatedness

causality_method

CodeableConcept

method1 | method2

causality_author

Reference

AdverseEvent.suspectEntity.causalityAuthor

causality_result

CodeableConcept

result1 | result2

AdverseEventCategoryCode

Overall categorization of the event, e.g. real or potential See http://hl7.org/fhir/ValueSet/adverse-event-category

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
AE
PAE

AdverseEventCausalityCode

TODO See http://hl7.org/fhir/ValueSet/adverse-event-causality

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
CAUSALITY1
CAUSALITY2

Age

Auto-generated from StructureDefinition for Age, last updated 2017-04-19T07:44:43.294+10:00. A duration of time during which an organism (or a process) has existed. See http://hl7.org/fhir/StructureDefinition/Age

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

value

Decimal

Numerical value (with implicit precision)

comparator

QuantityComparatorCode

< | <= | >= | > - how to understand the value

unit

String

Unit representation

system

Uri

System that defines coded unit form

code

Code

Coded form of the unit

AggregationModeCode

How resource references can be aggregated. See http://hl7.org/fhir/ValueSet/resource-aggregation-mode

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
CONTAINED
REFERENCED
BUNDLED

AllergyIntolerance

Auto-generated from StructureDefinition for AllergyIntolerance, last updated 2017-04-19T07:44:43.294+10:00. Allergy or Intolerance (generally: Risk of adverse reaction to a substance). See http://hl7.org/fhir/StructureDefinition/AllergyIntolerance

Fields
id

Id

Logical id of this artifact

meta

Meta

Metadata about the resource

implicit_rules

Uri

A set of rules under which this content was created

language

LanguageCode

Language of the resource content

text

Narrative

Text summary of the resource, for human interpretation

contained[]

ContainedResource

Contained, inline Resources

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

identifier[]

Identifier

External ids for this item

clinical_status

AllergyIntoleranceClinicalStatusCode

active | inactive | resolved

verification_status

AllergyIntoleranceVerificationStatusCode

unconfirmed | confirmed | refuted | entered-in-error

type

AllergyIntoleranceTypeCode

allergy | intolerance - Underlying mechanism (if known)

category[]

AllergyIntoleranceCategoryCode

food | medication | environment | biologic

criticality

AllergyIntoleranceCriticalityCode

low | high | unable-to-assess

code

CodeableConcept

Code that identifies the allergy or intolerance

patient

Reference

Who the sensitivity is for

onset

Onset

asserted_date

DateTime

Date record was believed accurate

recorder

Reference

Who recorded the sensitivity

asserter

Reference

Source of the information about the allergy

last_occurrence

DateTime

Date(/time) of last known occurrence of a reaction

note[]

Annotation

Additional text not captured in other fields

reaction[]

Reaction

Onset

When allergy or intolerance was identified

Fields

Union field onset.

onset can be only one of the following:

date_time

DateTime

age

Age

period

Period

range

Range

string_value

String

Reaction

Adverse Reaction Events linked to exposure to substance

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

substance

CodeableConcept

Specific substance or pharmaceutical product considered to be responsible for event

manifestation[]

CodeableConcept

Clinical symptoms/signs associated with the Event

description

String

Description of the event as a whole

onset

DateTime

Date(/time) when manifestations showed

severity

AllergyIntoleranceSeverityCode

mild | moderate | severe (of event as a whole)

exposure_route

CodeableConcept

How the subject was exposed to the substance

note[]

Annotation

Text about event not captured in other fields

AllergyIntoleranceCategoryCode

Category of an identified substance. See http://hl7.org/fhir/ValueSet/allergy-intolerance-category

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
FOOD
MEDICATION
ENVIRONMENT
BIOLOGIC

AllergyIntoleranceClinicalStatusCode

The clinical status of the allergy or intolerance. See http://hl7.org/fhir/ValueSet/allergy-clinical-status

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
ACTIVE
INACTIVE
RESOLVED

AllergyIntoleranceCriticalityCode

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. See http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
LOW
HIGH
UNABLE_TO_ASSESS

AllergyIntoleranceSeverityCode

Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. See http://hl7.org/fhir/ValueSet/reaction-event-severity

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
MILD
MODERATE
SEVERE

AllergyIntoleranceTypeCode

Identification of the underlying physiological mechanism for a Reaction Risk. See http://hl7.org/fhir/ValueSet/allergy-intolerance-type

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
ALLERGY
INTOLERANCE

AllergyIntoleranceVerificationStatusCode

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. See http://hl7.org/fhir/ValueSet/allergy-verification-status

Fields
value

Value

id

String

extension[]

Extension

Value

Enums
INVALID_UNINITIALIZED
UNCONFIRMED
CONFIRMED
REFUTED
ENTERED_IN_ERROR

Annotation

Auto-generated from StructureDefinition for Annotation, last updated 2017-04-19T07:44:43.294+10:00. Text node with attribution. See http://hl7.org/fhir/StructureDefinition/Annotation

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

author

Author

time

DateTime

When the annotation was made

text

String

The annotation - text content

Author

Individual responsible for the annotation

Fields

Union field author.

author can be only one of the following:

reference

Reference

string_value

String

Appointment

Auto-generated from StructureDefinition for Appointment, last updated 2017-04-19T07:44:43.294+10:00. A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). See http://hl7.org/fhir/StructureDefinition/Appointment

Fields
id

Id

Logical id of this artifact

meta

Meta

Metadata about the resource

implicit_rules

Uri

A set of rules under which this content was created

language

LanguageCode

Language of the resource content

text

Narrative

Text summary of the resource, for human interpretation

contained[]

ContainedResource

Contained, inline Resources

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

identifier[]

Identifier

External Ids for this item

status

AppointmentStatusCode

proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error

service_category

CodeableConcept

A broad categorisation of the service that is to be performed during this appointment

service_type[]

CodeableConcept

The specific service that is to be performed during this appointment

specialty[]

CodeableConcept

The specialty of a practitioner that would be required to perform the service requested in this appointment

appointment_type

CodeableConcept

The style of appointment or patient that has been booked in the slot (not service type)

reason[]

CodeableConcept

Reason this appointment is scheduled

indication[]

Reference

Reason the appointment is to takes place (resource)

priority

UnsignedInt

Used to make informed decisions if needing to re-prioritize

description

String

Shown on a subject line in a meeting request, or appointment list

supporting_information[]

Reference

Additional information to support the appointment

start

Instant

When appointment is to take place

end

Instant

When appointment is to conclude

minutes_duration

PositiveInt

Can be less than start/end (e.g. estimate)

slot[]

Reference

The slots that this appointment is filling

created

DateTime

The date that this appointment was initially created

comment

String

Additional comments

incoming_referral[]

Reference

The ReferralRequest provided as information to allocate to the Encounter

participant[]

Participant

requested_period[]

Period

Potential date/time interval(s) requested to allocate the appointment within

Participant

Participants involved in appointment

Fields
id

String

xml:id (or equivalent in JSON)

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

type[]

CodeableConcept

Role of participant in the appointment

actor

Reference

Person, Location/HealthcareService or Device

required

ParticipantRequiredCode

required | optional | information-only

status

ParticipationStatusCode

accepted | declined | tentative | needs-action

AppointmentResponse

Auto-generated from StructureDefinition for AppointmentResponse, last updated 2017-04-19T07:44:43.294+10:00. A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. See http://hl7.org/fhir/StructureDefinition/AppointmentResponse

Fields
id

Id

Logical id of this artifact

meta

Meta

Metadata about the resource

implicit_rules

Uri

A set of rules under which this content was created

language

LanguageCode

Language of the resource content

text

Narrative

Text summary of the resource, for human interpretation

contained[]

ContainedResource

Contained, inline Resources

extension[]

Extension

Additional Content defined by implementations

modifier_extension[]

Extension

Extensions that cannot be ignored

identifier[]

Identifier

External Ids for this item

appointment

Reference

Appointment this response relates to

start

Instant

Time from appointment, or requested new start time

end

Instant

Time from appointment, or requested new end time

participant_type[]

CodeableConcept

Role of participant in the appointment

actor

Reference

Person, Location/HealthcareService or Device

participant_status

ParticipationStatusCode

accepted | declined | tentative | in-process | completed | needs-action | entered-in-error

comment

String

Additional comments

AppointmentStatusCode

The free/busy status of an appointment. See http://hl7.org/fhir/ValueSet/appointmentstatus

Fields
value

Value

id

String