FHIR R5 Complex Types
Classes representing FHIR R5 complex data types.
Address
Path: fhircraft.fhir.resources.datatypes.R5.complex.address.Address
Bases: Element
An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
use
|
Code | None
|
home | work | temp | old | billing - purpose of this address |
None
|
use_ext
|
Element | None
|
Placeholder element for use extensions |
None
|
type
|
Code | None
|
postal | physical | both |
None
|
type_ext
|
Element | None
|
Placeholder element for type extensions |
None
|
text
|
String | None
|
Text representation of the address |
None
|
text_ext
|
Element | None
|
Placeholder element for text extensions |
None
|
line
|
List[String] | None
|
Street name, number, direction & P.O. Box etc. |
None
|
line_ext
|
Element | None
|
Placeholder element for line extensions |
None
|
city
|
String | None
|
Name of city, town etc. |
None
|
city_ext
|
Element | None
|
Placeholder element for city extensions |
None
|
district
|
String | None
|
District name (aka county) |
None
|
district_ext
|
Element | None
|
Placeholder element for district extensions |
None
|
state
|
String | None
|
Sub-unit of country (abbreviations ok) |
None
|
state_ext
|
Element | None
|
Placeholder element for state extensions |
None
|
postalCode
|
String | None
|
Postal code for area |
None
|
postalCode_ext
|
Element | None
|
Placeholder element for postalCode extensions |
None
|
country
|
String | None
|
Country (e.g. may be ISO 3166 2 or 3 letter code) |
None
|
country_ext
|
Element | None
|
Placeholder element for country extensions |
None
|
period
|
Period | None
|
Time period when address was/is in use |
None
|
Age
Path: fhircraft.fhir.resources.datatypes.R5.complex.age.Age
Bases: Quantity
A duration of time during which an organism (or a process) has existed
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
value
|
Decimal | None
|
Numerical value (with implicit precision) |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
comparator
|
Code | None
|
< | <= | >= | > | ad - how to understand the value |
None
|
comparator_ext
|
Element | None
|
Placeholder element for comparator extensions |
None
|
unit
|
String | None
|
Unit representation |
None
|
unit_ext
|
Element | None
|
Placeholder element for unit extensions |
None
|
system
|
Uri | None
|
System that defines coded unit form |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
code
|
Code | None
|
Coded form of the unit |
None
|
code_ext
|
Element | None
|
Placeholder element for code extensions |
None
|
Annotation
Path: fhircraft.fhir.resources.datatypes.R5.complex.annotation.Annotation
Bases: Element
Text node with attribution
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
authorReference
|
Reference | None
|
Individual responsible for the annotation |
None
|
authorString
|
String | None
|
Individual responsible for the annotation |
None
|
time
|
DateTime | None
|
When the annotation was made |
None
|
time_ext
|
Element | None
|
Placeholder element for time extensions |
None
|
text
|
Markdown | None
|
The annotation - text content (as markdown) |
None
|
text_ext
|
Element | None
|
Placeholder element for text extensions |
None
|
Attachment
Path: fhircraft.fhir.resources.datatypes.R5.complex.attachment.Attachment
Bases: Element
Content in a format defined elsewhere
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
contentType
|
Code | None
|
Mime type of the content, with charset etc. |
None
|
contentType_ext
|
Element | None
|
Placeholder element for contentType extensions |
None
|
language
|
Code | None
|
Human language of the content (BCP-47) |
None
|
language_ext
|
Element | None
|
Placeholder element for language extensions |
None
|
data
|
Base64Binary | None
|
Data inline, base64ed |
None
|
data_ext
|
Element | None
|
Placeholder element for data extensions |
None
|
url
|
Url | None
|
Uri where the data can be found |
None
|
url_ext
|
Element | None
|
Placeholder element for url extensions |
None
|
size
|
Integer64 | None
|
Number of bytes of content (if url provided) |
None
|
size_ext
|
Element | None
|
Placeholder element for size extensions |
None
|
hash
|
Base64Binary | None
|
Hash of the data (sha-1, base64ed) |
None
|
hash_ext
|
Element | None
|
Placeholder element for hash extensions |
None
|
title
|
String | None
|
Label to display in place of the data |
None
|
title_ext
|
Element | None
|
Placeholder element for title extensions |
None
|
creation
|
DateTime | None
|
Date attachment was first created |
None
|
creation_ext
|
Element | None
|
Placeholder element for creation extensions |
None
|
height
|
PositiveInt | None
|
Height of the image in pixels (photo/video) |
None
|
height_ext
|
Element | None
|
Placeholder element for height extensions |
None
|
width
|
PositiveInt | None
|
Width of the image in pixels (photo/video) |
None
|
width_ext
|
Element | None
|
Placeholder element for width extensions |
None
|
frames
|
PositiveInt | None
|
Number of frames if > 1 (photo) |
None
|
frames_ext
|
Element | None
|
Placeholder element for frames extensions |
None
|
duration
|
Decimal | None
|
Length in seconds (audio / video) |
None
|
duration_ext
|
Element | None
|
Placeholder element for duration extensions |
None
|
pages
|
PositiveInt | None
|
Number of printed pages |
None
|
pages_ext
|
Element | None
|
Placeholder element for pages extensions |
None
|
Availability
Path: fhircraft.fhir.resources.datatypes.R5.complex.availability.Availability
Bases: Element
Availability data for an {item}
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
availableTime
|
List[Element] | None
|
Times the {item} is available |
None
|
notAvailableTime
|
List[Element] | None
|
Not available during this time due to provided reason |
None
|
BackboneElement
Path: fhircraft.fhir.resources.datatypes.R5.complex.backbone_element.BackboneElement
Bases: Element
Base for elements defined inside a resource
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
modifierExtension
|
List[Extension] | None
|
Extensions that cannot be ignored even if unrecognized |
None
|
BackboneType
Path: fhircraft.fhir.resources.datatypes.R5.complex.backbone_type.BackboneType
Bases: Element
Base for datatypes that can carry modifier extensions
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
modifierExtension
|
List[Extension] | None
|
Extensions that cannot be ignored even if unrecognized |
None
|
Base
Path: fhircraft.fhir.resources.datatypes.R5.complex.base.Base
CodeableConcept
Path: fhircraft.fhir.resources.datatypes.R5.complex.codeable_concept.CodeableConcept
Bases: Element
Concept - reference to a terminology or just text
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
coding
|
List[Coding] | None
|
Code defined by a terminology system |
None
|
text
|
String | None
|
Plain text representation of the concept |
None
|
text_ext
|
Element | None
|
Placeholder element for text extensions |
None
|
CodeableReference
Path: fhircraft.fhir.resources.datatypes.R5.complex.codeable_reference.CodeableReference
Bases: Element
Reference to a resource or a concept
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
concept
|
CodeableConcept | None
|
Reference to a concept (by class) |
None
|
reference
|
Reference | None
|
Reference to a resource (by instance) |
None
|
Coding
Path: fhircraft.fhir.resources.datatypes.R5.complex.coding.Coding
Bases: Element
A reference to a code defined by a terminology system
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
system
|
Uri | None
|
Identity of the terminology system |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
version
|
String | None
|
Version of the system - if relevant |
None
|
version_ext
|
Element | None
|
Placeholder element for version extensions |
None
|
code
|
Code | None
|
Symbol in syntax defined by the system |
None
|
code_ext
|
Element | None
|
Placeholder element for code extensions |
None
|
display
|
String | None
|
Representation defined by the system |
None
|
display_ext
|
Element | None
|
Placeholder element for display extensions |
None
|
userSelected
|
Boolean | None
|
If this coding was chosen directly by the user |
None
|
userSelected_ext
|
Element | None
|
Placeholder element for userSelected extensions |
None
|
ContactDetail
Path: fhircraft.fhir.resources.datatypes.R5.complex.contact_detail.ContactDetail
Bases: Element
Contact information
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
name
|
String | None
|
Name of an individual to contact |
None
|
name_ext
|
Element | None
|
Placeholder element for name extensions |
None
|
telecom
|
List[ContactPoint] | None
|
Contact details for individual or organization |
None
|
ContactPoint
Path: fhircraft.fhir.resources.datatypes.R5.complex.contact_point.ContactPoint
Bases: Element
Details of a Technology mediated contact point (phone, fax, email, etc.)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
system
|
Code | None
|
phone | fax | email | pager | url | sms | other |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
value
|
String | None
|
The actual contact point details |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
use
|
Code | None
|
home | work | temp | old | mobile - purpose of this contact point |
None
|
use_ext
|
Element | None
|
Placeholder element for use extensions |
None
|
rank
|
PositiveInt | None
|
Specify preferred order of use (1 = highest) |
None
|
rank_ext
|
Element | None
|
Placeholder element for rank extensions |
None
|
period
|
Period | None
|
Time period when the contact point was/is in use |
None
|
Contributor
Path: fhircraft.fhir.resources.datatypes.R5.complex.contributor.Contributor
Bases: Element
Contributor information
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
type
|
Code | None
|
author | editor | reviewer | endorser |
None
|
type_ext
|
Element | None
|
Placeholder element for type extensions |
None
|
name
|
String | None
|
Who contributed the content |
None
|
name_ext
|
Element | None
|
Placeholder element for name extensions |
None
|
contact
|
List[ContactDetail] | None
|
Contact details of the contributor |
None
|
Count
Path: fhircraft.fhir.resources.datatypes.R5.complex.count.Count
Bases: Quantity
A measured or measurable amount
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
value
|
Decimal | None
|
Numerical value (with implicit precision) |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
comparator
|
Code | None
|
< | <= | >= | > | ad - how to understand the value |
None
|
comparator_ext
|
Element | None
|
Placeholder element for comparator extensions |
None
|
unit
|
String | None
|
Unit representation |
None
|
unit_ext
|
Element | None
|
Placeholder element for unit extensions |
None
|
system
|
Uri | None
|
System that defines coded unit form |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
code
|
Code | None
|
Coded form of the unit |
None
|
code_ext
|
Element | None
|
Placeholder element for code extensions |
None
|
DataRequirement
Path: fhircraft.fhir.resources.datatypes.R5.complex.data_requirement.DataRequirement
Bases: Element
Describes a required data item
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
type
|
Code | None
|
The type of the required data |
None
|
type_ext
|
Element | None
|
Placeholder element for type extensions |
None
|
profile
|
List[Canonical] | None
|
The profile of the required data |
None
|
profile_ext
|
Element | None
|
Placeholder element for profile extensions |
None
|
subjectCodeableConcept
|
CodeableConcept | None
|
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device |
None
|
subjectReference
|
Reference | None
|
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device |
None
|
mustSupport
|
List[String] | None
|
Indicates specific structure elements that are referenced by the knowledge module |
None
|
mustSupport_ext
|
Element | None
|
Placeholder element for mustSupport extensions |
None
|
codeFilter
|
List[Element] | None
|
What codes are expected |
None
|
dateFilter
|
List[Element] | None
|
What dates/date ranges are expected |
None
|
valueFilter
|
List[Element] | None
|
What values are expected |
None
|
limit
|
PositiveInt | None
|
Number of results |
None
|
limit_ext
|
Element | None
|
Placeholder element for limit extensions |
None
|
sort
|
List[Element] | None
|
Order of the results |
None
|
DataType
Path: fhircraft.fhir.resources.datatypes.R5.complex.data_type.DataType
Distance
Path: fhircraft.fhir.resources.datatypes.R5.complex.distance.Distance
Bases: Quantity
A length - a value with a unit that is a physical distance
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
value
|
Decimal | None
|
Numerical value (with implicit precision) |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
comparator
|
Code | None
|
< | <= | >= | > | ad - how to understand the value |
None
|
comparator_ext
|
Element | None
|
Placeholder element for comparator extensions |
None
|
unit
|
String | None
|
Unit representation |
None
|
unit_ext
|
Element | None
|
Placeholder element for unit extensions |
None
|
system
|
Uri | None
|
System that defines coded unit form |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
code
|
Code | None
|
Coded form of the unit |
None
|
code_ext
|
Element | None
|
Placeholder element for code extensions |
None
|
DomainResource
Path: fhircraft.fhir.resources.datatypes.R5.complex.domain_resource.DomainResource
Bases: Resource
A resource with narrative, extensions, and contained resources
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Logical id of this artifact |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
meta
|
Meta | None
|
Metadata about the resource |
None
|
implicitRules
|
Uri | None
|
A set of rules under which this content was created |
None
|
implicitRules_ext
|
Element | None
|
Placeholder element for implicitRules extensions |
None
|
language
|
Code | None
|
Language of the resource content |
None
|
language_ext
|
Element | None
|
Placeholder element for language extensions |
None
|
text
|
Narrative | None
|
Text summary of the resource, for human interpretation |
None
|
contained
|
List[Resource] | None
|
Contained, inline Resources |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
modifierExtension
|
List[Extension] | None
|
Extensions that cannot be ignored |
None
|
Dosage
Path: fhircraft.fhir.resources.datatypes.R5.complex.dosage.Dosage
Bases: BackboneType
How the medication is/was taken or should be taken
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
modifierExtension
|
List[Extension] | None
|
Extensions that cannot be ignored even if unrecognized |
None
|
sequence
|
Integer | None
|
The order of the dosage instructions |
None
|
sequence_ext
|
Element | None
|
Placeholder element for sequence extensions |
None
|
text
|
String | None
|
Free text dosage instructions e.g. SIG |
None
|
text_ext
|
Element | None
|
Placeholder element for text extensions |
None
|
additionalInstruction
|
List[CodeableConcept] | None
|
Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" |
None
|
patientInstruction
|
String | None
|
Patient or consumer oriented instructions |
None
|
patientInstruction_ext
|
Element | None
|
Placeholder element for patientInstruction extensions |
None
|
timing
|
Timing | None
|
When medication should be administered |
None
|
asNeeded
|
Boolean | None
|
Take "as needed" |
None
|
asNeeded_ext
|
Element | None
|
Placeholder element for asNeeded extensions |
None
|
asNeededFor
|
List[CodeableConcept] | None
|
Take "as needed" (for x) |
None
|
site
|
CodeableConcept | None
|
Body site to administer to |
None
|
route
|
CodeableConcept | None
|
How drug should enter body |
None
|
method
|
CodeableConcept | None
|
Technique for administering medication |
None
|
doseAndRate
|
List[Element] | None
|
Amount of medication administered, to be administered or typical amount to be administered |
None
|
maxDosePerPeriod
|
List[Ratio] | None
|
Upper limit on medication per unit of time |
None
|
maxDosePerAdministration
|
Quantity | None
|
Upper limit on medication per administration |
None
|
maxDosePerLifetime
|
Quantity | None
|
Upper limit on medication per lifetime of the patient |
None
|
Duration
Path: fhircraft.fhir.resources.datatypes.R5.complex.duration.Duration
Bases: Quantity
A length of time
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
value
|
Decimal | None
|
Numerical value (with implicit precision) |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
comparator
|
Code | None
|
< | <= | >= | > | ad - how to understand the value |
None
|
comparator_ext
|
Element | None
|
Placeholder element for comparator extensions |
None
|
unit
|
String | None
|
Unit representation |
None
|
unit_ext
|
Element | None
|
Placeholder element for unit extensions |
None
|
system
|
Uri | None
|
System that defines coded unit form |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
code
|
Code | None
|
Coded form of the unit |
None
|
code_ext
|
Element | None
|
Placeholder element for code extensions |
None
|
Element
Path: fhircraft.fhir.resources.datatypes.R5.complex.element.Element
ElementDefinition
Path: fhircraft.fhir.resources.datatypes.R5.complex.element_definition.ElementDefinition
Bases: BackboneType
Definition of an element in a resource or extension
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
modifierExtension
|
List[Extension] | None
|
Extensions that cannot be ignored even if unrecognized |
None
|
path
|
String | None
|
Path of the element in the hierarchy of elements |
None
|
path_ext
|
Element | None
|
Placeholder element for path extensions |
None
|
representation
|
List[Code] | None
|
xmlAttr | xmlText | typeAttr | cdaText | xhtml |
None
|
representation_ext
|
Element | None
|
Placeholder element for representation extensions |
None
|
sliceName
|
String | None
|
Name for this particular element (in a set of slices) |
None
|
sliceName_ext
|
Element | None
|
Placeholder element for sliceName extensions |
None
|
sliceIsConstraining
|
Boolean | None
|
If this slice definition constrains an inherited slice definition (or not) |
None
|
sliceIsConstraining_ext
|
Element | None
|
Placeholder element for sliceIsConstraining extensions |
None
|
label
|
String | None
|
Name for element to display with or prompt for element |
None
|
label_ext
|
Element | None
|
Placeholder element for label extensions |
None
|
code
|
List[Coding] | None
|
Corresponding codes in terminologies |
None
|
slicing
|
Element | None
|
This element is sliced - slices follow |
None
|
short
|
String | None
|
Concise definition for space-constrained presentation |
None
|
short_ext
|
Element | None
|
Placeholder element for short extensions |
None
|
definition
|
Markdown | None
|
Full formal definition as narrative text |
None
|
definition_ext
|
Element | None
|
Placeholder element for definition extensions |
None
|
comment
|
Markdown | None
|
Comments about the use of this element |
None
|
comment_ext
|
Element | None
|
Placeholder element for comment extensions |
None
|
requirements
|
Markdown | None
|
Why this resource has been created |
None
|
requirements_ext
|
Element | None
|
Placeholder element for requirements extensions |
None
|
alias
|
List[String] | None
|
Other names |
None
|
alias_ext
|
Element | None
|
Placeholder element for alias extensions |
None
|
min
|
UnsignedInt | None
|
Minimum Cardinality |
None
|
min_ext
|
Element | None
|
Placeholder element for min extensions |
None
|
max
|
String | None
|
Maximum Cardinality (a number or *) |
None
|
max_ext
|
Element | None
|
Placeholder element for max extensions |
None
|
base
|
Element | None
|
Base definition information for tools |
None
|
contentReference
|
Uri | None
|
Reference to definition of content for the element |
None
|
contentReference_ext
|
Element | None
|
Placeholder element for contentReference extensions |
None
|
type
|
List[Element] | None
|
Data type and Profile for this element |
None
|
defaultValueBase64Binary
|
Base64Binary | None
|
Specified value if missing from instance |
None
|
defaultValueBoolean
|
Boolean | None
|
Specified value if missing from instance |
None
|
defaultValueCanonical
|
Canonical | None
|
Specified value if missing from instance |
None
|
defaultValueCode
|
Code | None
|
Specified value if missing from instance |
None
|
defaultValueDate
|
Date | None
|
Specified value if missing from instance |
None
|
defaultValueDateTime
|
DateTime | None
|
Specified value if missing from instance |
None
|
defaultValueDecimal
|
Decimal | None
|
Specified value if missing from instance |
None
|
defaultValueId
|
Id | None
|
Specified value if missing from instance |
None
|
defaultValueInstant
|
Instant | None
|
Specified value if missing from instance |
None
|
defaultValueInteger
|
Integer | None
|
Specified value if missing from instance |
None
|
defaultValueInteger64
|
Integer64 | None
|
Specified value if missing from instance |
None
|
defaultValueMarkdown
|
Markdown | None
|
Specified value if missing from instance |
None
|
defaultValueOid
|
Oid | None
|
Specified value if missing from instance |
None
|
defaultValuePositiveInt
|
PositiveInt | None
|
Specified value if missing from instance |
None
|
defaultValueString
|
String | None
|
Specified value if missing from instance |
None
|
defaultValueTime
|
Time | None
|
Specified value if missing from instance |
None
|
defaultValueUnsignedInt
|
UnsignedInt | None
|
Specified value if missing from instance |
None
|
defaultValueUri
|
Uri | None
|
Specified value if missing from instance |
None
|
defaultValueUrl
|
Url | None
|
Specified value if missing from instance |
None
|
defaultValueUuid
|
Uuid | None
|
Specified value if missing from instance |
None
|
defaultValueAddress
|
Address | None
|
Specified value if missing from instance |
None
|
defaultValueAge
|
Age | None
|
Specified value if missing from instance |
None
|
defaultValueAnnotation
|
Annotation | None
|
Specified value if missing from instance |
None
|
defaultValueAttachment
|
Attachment | None
|
Specified value if missing from instance |
None
|
defaultValueCodeableConcept
|
CodeableConcept | None
|
Specified value if missing from instance |
None
|
defaultValueCodeableReference
|
CodeableReference | None
|
Specified value if missing from instance |
None
|
defaultValueCoding
|
Coding | None
|
Specified value if missing from instance |
None
|
defaultValueContactPoint
|
ContactPoint | None
|
Specified value if missing from instance |
None
|
defaultValueCount
|
Count | None
|
Specified value if missing from instance |
None
|
defaultValueDistance
|
Distance | None
|
Specified value if missing from instance |
None
|
defaultValueDuration
|
Duration | None
|
Specified value if missing from instance |
None
|
defaultValueHumanName
|
HumanName | None
|
Specified value if missing from instance |
None
|
defaultValueIdentifier
|
Identifier | None
|
Specified value if missing from instance |
None
|
defaultValueMoney
|
Money | None
|
Specified value if missing from instance |
None
|
defaultValuePeriod
|
Period | None
|
Specified value if missing from instance |
None
|
defaultValueQuantity
|
Quantity | None
|
Specified value if missing from instance |
None
|
defaultValueRange
|
Range | None
|
Specified value if missing from instance |
None
|
defaultValueRatio
|
Ratio | None
|
Specified value if missing from instance |
None
|
defaultValueRatioRange
|
RatioRange | None
|
Specified value if missing from instance |
None
|
defaultValueReference
|
Reference | None
|
Specified value if missing from instance |
None
|
defaultValueSampledData
|
SampledData | None
|
Specified value if missing from instance |
None
|
defaultValueSignature
|
Signature | None
|
Specified value if missing from instance |
None
|
defaultValueTiming
|
Timing | None
|
Specified value if missing from instance |
None
|
defaultValueContactDetail
|
ContactDetail | None
|
Specified value if missing from instance |
None
|
defaultValueDataRequirement
|
DataRequirement | None
|
Specified value if missing from instance |
None
|
defaultValueExpression
|
Expression | None
|
Specified value if missing from instance |
None
|
defaultValueParameterDefinition
|
ParameterDefinition | None
|
Specified value if missing from instance |
None
|
defaultValueRelatedArtifact
|
RelatedArtifact | None
|
Specified value if missing from instance |
None
|
defaultValueTriggerDefinition
|
TriggerDefinition | None
|
Specified value if missing from instance |
None
|
defaultValueUsageContext
|
UsageContext | None
|
Specified value if missing from instance |
None
|
defaultValueAvailability
|
Availability | None
|
Specified value if missing from instance |
None
|
defaultValueExtendedContactDetail
|
ExtendedContactDetail | None
|
Specified value if missing from instance |
None
|
defaultValueDosage
|
Dosage | None
|
Specified value if missing from instance |
None
|
defaultValueMeta
|
Meta | None
|
Specified value if missing from instance |
None
|
meaningWhenMissing
|
Markdown | None
|
Implicit meaning when this element is missing |
None
|
meaningWhenMissing_ext
|
Element | None
|
Placeholder element for meaningWhenMissing extensions |
None
|
orderMeaning
|
String | None
|
What the order of the elements means |
None
|
orderMeaning_ext
|
Element | None
|
Placeholder element for orderMeaning extensions |
None
|
fixedBase64Binary
|
Base64Binary | None
|
Value must be exactly this |
None
|
fixedBoolean
|
Boolean | None
|
Value must be exactly this |
None
|
fixedCanonical
|
Canonical | None
|
Value must be exactly this |
None
|
fixedCode
|
Code | None
|
Value must be exactly this |
None
|
fixedDate
|
Date | None
|
Value must be exactly this |
None
|
fixedDateTime
|
DateTime | None
|
Value must be exactly this |
None
|
fixedDecimal
|
Decimal | None
|
Value must be exactly this |
None
|
fixedId
|
Id | None
|
Value must be exactly this |
None
|
fixedInstant
|
Instant | None
|
Value must be exactly this |
None
|
fixedInteger
|
Integer | None
|
Value must be exactly this |
None
|
fixedInteger64
|
Integer64 | None
|
Value must be exactly this |
None
|
fixedMarkdown
|
Markdown | None
|
Value must be exactly this |
None
|
fixedOid
|
Oid | None
|
Value must be exactly this |
None
|
fixedPositiveInt
|
PositiveInt | None
|
Value must be exactly this |
None
|
fixedString
|
String | None
|
Value must be exactly this |
None
|
fixedTime
|
Time | None
|
Value must be exactly this |
None
|
fixedUnsignedInt
|
UnsignedInt | None
|
Value must be exactly this |
None
|
fixedUri
|
Uri | None
|
Value must be exactly this |
None
|
fixedUrl
|
Url | None
|
Value must be exactly this |
None
|
fixedUuid
|
Uuid | None
|
Value must be exactly this |
None
|
fixedAddress
|
Address | None
|
Value must be exactly this |
None
|
fixedAge
|
Age | None
|
Value must be exactly this |
None
|
fixedAnnotation
|
Annotation | None
|
Value must be exactly this |
None
|
fixedAttachment
|
Attachment | None
|
Value must be exactly this |
None
|
fixedCodeableConcept
|
CodeableConcept | None
|
Value must be exactly this |
None
|
fixedCodeableReference
|
CodeableReference | None
|
Value must be exactly this |
None
|
fixedCoding
|
Coding | None
|
Value must be exactly this |
None
|
fixedContactPoint
|
ContactPoint | None
|
Value must be exactly this |
None
|
fixedCount
|
Count | None
|
Value must be exactly this |
None
|
fixedDistance
|
Distance | None
|
Value must be exactly this |
None
|
fixedDuration
|
Duration | None
|
Value must be exactly this |
None
|
fixedHumanName
|
HumanName | None
|
Value must be exactly this |
None
|
fixedIdentifier
|
Identifier | None
|
Value must be exactly this |
None
|
fixedMoney
|
Money | None
|
Value must be exactly this |
None
|
fixedPeriod
|
Period | None
|
Value must be exactly this |
None
|
fixedQuantity
|
Quantity | None
|
Value must be exactly this |
None
|
fixedRange
|
Range | None
|
Value must be exactly this |
None
|
fixedRatio
|
Ratio | None
|
Value must be exactly this |
None
|
fixedRatioRange
|
RatioRange | None
|
Value must be exactly this |
None
|
fixedReference
|
Reference | None
|
Value must be exactly this |
None
|
fixedSampledData
|
SampledData | None
|
Value must be exactly this |
None
|
fixedSignature
|
Signature | None
|
Value must be exactly this |
None
|
fixedTiming
|
Timing | None
|
Value must be exactly this |
None
|
fixedContactDetail
|
ContactDetail | None
|
Value must be exactly this |
None
|
fixedDataRequirement
|
DataRequirement | None
|
Value must be exactly this |
None
|
fixedExpression
|
Expression | None
|
Value must be exactly this |
None
|
fixedParameterDefinition
|
ParameterDefinition | None
|
Value must be exactly this |
None
|
fixedRelatedArtifact
|
RelatedArtifact | None
|
Value must be exactly this |
None
|
fixedTriggerDefinition
|
TriggerDefinition | None
|
Value must be exactly this |
None
|
fixedUsageContext
|
UsageContext | None
|
Value must be exactly this |
None
|
fixedAvailability
|
Availability | None
|
Value must be exactly this |
None
|
fixedExtendedContactDetail
|
ExtendedContactDetail | None
|
Value must be exactly this |
None
|
fixedDosage
|
Dosage | None
|
Value must be exactly this |
None
|
fixedMeta
|
Meta | None
|
Value must be exactly this |
None
|
patternBase64Binary
|
Base64Binary | None
|
Value must have at least these property values |
None
|
patternBoolean
|
Boolean | None
|
Value must have at least these property values |
None
|
patternCanonical
|
Canonical | None
|
Value must have at least these property values |
None
|
patternCode
|
Code | None
|
Value must have at least these property values |
None
|
patternDate
|
Date | None
|
Value must have at least these property values |
None
|
patternDateTime
|
DateTime | None
|
Value must have at least these property values |
None
|
patternDecimal
|
Decimal | None
|
Value must have at least these property values |
None
|
patternId
|
Id | None
|
Value must have at least these property values |
None
|
patternInstant
|
Instant | None
|
Value must have at least these property values |
None
|
patternInteger
|
Integer | None
|
Value must have at least these property values |
None
|
patternInteger64
|
Integer64 | None
|
Value must have at least these property values |
None
|
patternMarkdown
|
Markdown | None
|
Value must have at least these property values |
None
|
patternOid
|
Oid | None
|
Value must have at least these property values |
None
|
patternPositiveInt
|
PositiveInt | None
|
Value must have at least these property values |
None
|
patternString
|
String | None
|
Value must have at least these property values |
None
|
patternTime
|
Time | None
|
Value must have at least these property values |
None
|
patternUnsignedInt
|
UnsignedInt | None
|
Value must have at least these property values |
None
|
patternUri
|
Uri | None
|
Value must have at least these property values |
None
|
patternUrl
|
Url | None
|
Value must have at least these property values |
None
|
patternUuid
|
Uuid | None
|
Value must have at least these property values |
None
|
patternAddress
|
Address | None
|
Value must have at least these property values |
None
|
patternAge
|
Age | None
|
Value must have at least these property values |
None
|
patternAnnotation
|
Annotation | None
|
Value must have at least these property values |
None
|
patternAttachment
|
Attachment | None
|
Value must have at least these property values |
None
|
patternCodeableConcept
|
CodeableConcept | None
|
Value must have at least these property values |
None
|
patternCodeableReference
|
CodeableReference | None
|
Value must have at least these property values |
None
|
patternCoding
|
Coding | None
|
Value must have at least these property values |
None
|
patternContactPoint
|
ContactPoint | None
|
Value must have at least these property values |
None
|
patternCount
|
Count | None
|
Value must have at least these property values |
None
|
patternDistance
|
Distance | None
|
Value must have at least these property values |
None
|
patternDuration
|
Duration | None
|
Value must have at least these property values |
None
|
patternHumanName
|
HumanName | None
|
Value must have at least these property values |
None
|
patternIdentifier
|
Identifier | None
|
Value must have at least these property values |
None
|
patternMoney
|
Money | None
|
Value must have at least these property values |
None
|
patternPeriod
|
Period | None
|
Value must have at least these property values |
None
|
patternQuantity
|
Quantity | None
|
Value must have at least these property values |
None
|
patternRange
|
Range | None
|
Value must have at least these property values |
None
|
patternRatio
|
Ratio | None
|
Value must have at least these property values |
None
|
patternRatioRange
|
RatioRange | None
|
Value must have at least these property values |
None
|
patternReference
|
Reference | None
|
Value must have at least these property values |
None
|
patternSampledData
|
SampledData | None
|
Value must have at least these property values |
None
|
patternSignature
|
Signature | None
|
Value must have at least these property values |
None
|
patternTiming
|
Timing | None
|
Value must have at least these property values |
None
|
patternContactDetail
|
ContactDetail | None
|
Value must have at least these property values |
None
|
patternDataRequirement
|
DataRequirement | None
|
Value must have at least these property values |
None
|
patternExpression
|
Expression | None
|
Value must have at least these property values |
None
|
patternParameterDefinition
|
ParameterDefinition | None
|
Value must have at least these property values |
None
|
patternRelatedArtifact
|
RelatedArtifact | None
|
Value must have at least these property values |
None
|
patternTriggerDefinition
|
TriggerDefinition | None
|
Value must have at least these property values |
None
|
patternUsageContext
|
UsageContext | None
|
Value must have at least these property values |
None
|
patternAvailability
|
Availability | None
|
Value must have at least these property values |
None
|
patternExtendedContactDetail
|
ExtendedContactDetail | None
|
Value must have at least these property values |
None
|
patternDosage
|
Dosage | None
|
Value must have at least these property values |
None
|
patternMeta
|
Meta | None
|
Value must have at least these property values |
None
|
example
|
List[Element] | None
|
Example value (as defined for type) |
None
|
minValueDate
|
Date | None
|
Minimum Allowed Value (for some types) |
None
|
minValueDateTime
|
DateTime | None
|
Minimum Allowed Value (for some types) |
None
|
minValueInstant
|
Instant | None
|
Minimum Allowed Value (for some types) |
None
|
minValueTime
|
Time | None
|
Minimum Allowed Value (for some types) |
None
|
minValueDecimal
|
Decimal | None
|
Minimum Allowed Value (for some types) |
None
|
minValueInteger
|
Integer | None
|
Minimum Allowed Value (for some types) |
None
|
minValueInteger64
|
Integer64 | None
|
Minimum Allowed Value (for some types) |
None
|
minValuePositiveInt
|
PositiveInt | None
|
Minimum Allowed Value (for some types) |
None
|
minValueUnsignedInt
|
UnsignedInt | None
|
Minimum Allowed Value (for some types) |
None
|
minValueQuantity
|
Quantity | None
|
Minimum Allowed Value (for some types) |
None
|
maxValueDate
|
Date | None
|
Maximum Allowed Value (for some types) |
None
|
maxValueDateTime
|
DateTime | None
|
Maximum Allowed Value (for some types) |
None
|
maxValueInstant
|
Instant | None
|
Maximum Allowed Value (for some types) |
None
|
maxValueTime
|
Time | None
|
Maximum Allowed Value (for some types) |
None
|
maxValueDecimal
|
Decimal | None
|
Maximum Allowed Value (for some types) |
None
|
maxValueInteger
|
Integer | None
|
Maximum Allowed Value (for some types) |
None
|
maxValueInteger64
|
Integer64 | None
|
Maximum Allowed Value (for some types) |
None
|
maxValuePositiveInt
|
PositiveInt | None
|
Maximum Allowed Value (for some types) |
None
|
maxValueUnsignedInt
|
UnsignedInt | None
|
Maximum Allowed Value (for some types) |
None
|
maxValueQuantity
|
Quantity | None
|
Maximum Allowed Value (for some types) |
None
|
maxLength
|
Integer | None
|
Max length for string type data |
None
|
maxLength_ext
|
Element | None
|
Placeholder element for maxLength extensions |
None
|
condition
|
List[Id] | None
|
Reference to invariant about presence |
None
|
condition_ext
|
Element | None
|
Placeholder element for condition extensions |
None
|
constraint
|
List[Element] | None
|
Condition that must evaluate to true |
None
|
mustHaveValue
|
Boolean | None
|
For primitives, that a value must be present - not replaced by an extension |
None
|
mustHaveValue_ext
|
Element | None
|
Placeholder element for mustHaveValue extensions |
None
|
valueAlternatives
|
List[Canonical] | None
|
Extensions that are allowed to replace a primitive value |
None
|
valueAlternatives_ext
|
Element | None
|
Placeholder element for valueAlternatives extensions |
None
|
mustSupport
|
Boolean | None
|
If the element must be supported (discouraged - see obligations) |
None
|
mustSupport_ext
|
Element | None
|
Placeholder element for mustSupport extensions |
None
|
isModifier
|
Boolean | None
|
If this modifies the meaning of other elements |
None
|
isModifier_ext
|
Element | None
|
Placeholder element for isModifier extensions |
None
|
isModifierReason
|
String | None
|
Reason that this element is marked as a modifier |
None
|
isModifierReason_ext
|
Element | None
|
Placeholder element for isModifierReason extensions |
None
|
isSummary
|
Boolean | None
|
Include when _summary = true? |
None
|
isSummary_ext
|
Element | None
|
Placeholder element for isSummary extensions |
None
|
binding
|
Element | None
|
ValueSet details if this is coded |
None
|
mapping
|
List[Element] | None
|
Map element to another set of definitions |
None
|
Expression
Path: fhircraft.fhir.resources.datatypes.R5.complex.expression.Expression
Bases: DataType
An expression that can be used to generate a value
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
description
|
String | None
|
Natural language description of the condition |
None
|
description_ext
|
Element | None
|
Placeholder element for description extensions |
None
|
name
|
Code | None
|
Short name assigned to expression for reuse |
None
|
name_ext
|
Element | None
|
Placeholder element for name extensions |
None
|
language
|
Code | None
|
text/cql | text/fhirpath | application/x-fhir-query | etc. |
None
|
language_ext
|
Element | None
|
Placeholder element for language extensions |
None
|
expression
|
String | None
|
Expression in specified language |
None
|
expression_ext
|
Element | None
|
Placeholder element for expression extensions |
None
|
reference
|
Uri | None
|
Where the expression is found |
None
|
reference_ext
|
Element | None
|
Placeholder element for reference extensions |
None
|
ExtendedContactDetail
Path: fhircraft.fhir.resources.datatypes.R5.complex.extended_contact_detail.ExtendedContactDetail
Bases: DataType
Contact information
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
purpose
|
CodeableConcept | None
|
The type of contact |
None
|
name
|
List[HumanName] | None
|
Name of an individual to contact |
None
|
telecom
|
List[ContactPoint] | None
|
Contact details (e.g.phone/fax/url) |
None
|
address
|
Address | None
|
Address for the contact |
None
|
organization
|
Reference | None
|
This contact detail is handled/monitored by a specific organization |
None
|
period
|
Period | None
|
Period that this contact was valid for usage |
None
|
Extension
Path: fhircraft.fhir.resources.datatypes.R5.complex.extension.Extension
Bases: DataType
Optional Extensions Element
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
url
|
String | None
|
identifies the meaning of the extension |
None
|
url_ext
|
Element | None
|
Placeholder element for url extensions |
None
|
valueBase64Binary
|
Base64Binary | None
|
Value of extension |
None
|
valueBoolean
|
Boolean | None
|
Value of extension |
None
|
valueCanonical
|
Canonical | None
|
Value of extension |
None
|
valueCode
|
Code | None
|
Value of extension |
None
|
valueDate
|
Date | None
|
Value of extension |
None
|
valueDateTime
|
DateTime | None
|
Value of extension |
None
|
valueDecimal
|
Decimal | None
|
Value of extension |
None
|
valueId
|
Id | None
|
Value of extension |
None
|
valueInstant
|
Instant | None
|
Value of extension |
None
|
valueInteger
|
Integer | None
|
Value of extension |
None
|
valueInteger64
|
Integer64 | None
|
Value of extension |
None
|
valueMarkdown
|
Markdown | None
|
Value of extension |
None
|
valueOid
|
Oid | None
|
Value of extension |
None
|
valuePositiveInt
|
PositiveInt | None
|
Value of extension |
None
|
valueString
|
String | None
|
Value of extension |
None
|
valueTime
|
Time | None
|
Value of extension |
None
|
valueUnsignedInt
|
UnsignedInt | None
|
Value of extension |
None
|
valueUri
|
Uri | None
|
Value of extension |
None
|
valueUrl
|
Url | None
|
Value of extension |
None
|
valueUuid
|
Uuid | None
|
Value of extension |
None
|
valueAddress
|
Address | None
|
Value of extension |
None
|
valueAge
|
Age | None
|
Value of extension |
None
|
valueAnnotation
|
Annotation | None
|
Value of extension |
None
|
valueAttachment
|
Attachment | None
|
Value of extension |
None
|
valueCodeableConcept
|
CodeableConcept | None
|
Value of extension |
None
|
valueCodeableReference
|
CodeableReference | None
|
Value of extension |
None
|
valueCoding
|
Coding | None
|
Value of extension |
None
|
valueContactPoint
|
ContactPoint | None
|
Value of extension |
None
|
valueCount
|
Count | None
|
Value of extension |
None
|
valueDistance
|
Distance | None
|
Value of extension |
None
|
valueDuration
|
Duration | None
|
Value of extension |
None
|
valueHumanName
|
HumanName | None
|
Value of extension |
None
|
valueIdentifier
|
Identifier | None
|
Value of extension |
None
|
valueMoney
|
Money | None
|
Value of extension |
None
|
valuePeriod
|
Period | None
|
Value of extension |
None
|
valueQuantity
|
Quantity | None
|
Value of extension |
None
|
valueRange
|
Range | None
|
Value of extension |
None
|
valueRatio
|
Ratio | None
|
Value of extension |
None
|
valueRatioRange
|
RatioRange | None
|
Value of extension |
None
|
valueReference
|
Reference | None
|
Value of extension |
None
|
valueSampledData
|
SampledData | None
|
Value of extension |
None
|
valueSignature
|
Signature | None
|
Value of extension |
None
|
valueTiming
|
Timing | None
|
Value of extension |
None
|
valueContactDetail
|
ContactDetail | None
|
Value of extension |
None
|
valueDataRequirement
|
DataRequirement | None
|
Value of extension |
None
|
valueExpression
|
Expression | None
|
Value of extension |
None
|
valueParameterDefinition
|
ParameterDefinition | None
|
Value of extension |
None
|
valueRelatedArtifact
|
RelatedArtifact | None
|
Value of extension |
None
|
valueTriggerDefinition
|
TriggerDefinition | None
|
Value of extension |
None
|
valueUsageContext
|
UsageContext | None
|
Value of extension |
None
|
valueAvailability
|
Availability | None
|
Value of extension |
None
|
valueExtendedContactDetail
|
ExtendedContactDetail | None
|
Value of extension |
None
|
valueDosage
|
Dosage | None
|
Value of extension |
None
|
valueMeta
|
Meta | None
|
Value of extension |
None
|
HumanName
Path: fhircraft.fhir.resources.datatypes.R5.complex.human_name.HumanName
Bases: DataType
Name of a human or other living entity - parts and usage
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
use
|
Code | None
|
usual | official | temp | nickname | anonymous | old | maiden |
None
|
use_ext
|
Element | None
|
Placeholder element for use extensions |
None
|
text
|
String | None
|
Text representation of the full name |
None
|
text_ext
|
Element | None
|
Placeholder element for text extensions |
None
|
family
|
String | None
|
Family name (often called 'Surname') |
None
|
family_ext
|
Element | None
|
Placeholder element for family extensions |
None
|
given
|
List[String] | None
|
Given names (not always 'first'). Includes middle names |
None
|
given_ext
|
Element | None
|
Placeholder element for given extensions |
None
|
prefix
|
List[String] | None
|
Parts that come before the name |
None
|
prefix_ext
|
Element | None
|
Placeholder element for prefix extensions |
None
|
suffix
|
List[String] | None
|
Parts that come after the name |
None
|
suffix_ext
|
Element | None
|
Placeholder element for suffix extensions |
None
|
period
|
Period | None
|
Time period when name was/is in use |
None
|
Identifier
Path: fhircraft.fhir.resources.datatypes.R5.complex.identifier.Identifier
Bases: DataType
An identifier intended for computation
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
use
|
Code | None
|
usual | official | temp | secondary | old (If known) |
None
|
use_ext
|
Element | None
|
Placeholder element for use extensions |
None
|
type
|
CodeableConcept | None
|
Description of identifier |
None
|
system
|
Uri | None
|
The namespace for the identifier value |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
value
|
String | None
|
The value that is unique |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
period
|
Period | None
|
Time period when id is/was valid for use |
None
|
assigner
|
Reference | None
|
Organization that issued id (may be just text) |
None
|
MarketingStatus
Path: fhircraft.fhir.resources.datatypes.R5.complex.marketing_status.MarketingStatus
Bases: BackboneType
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
modifierExtension
|
List[Extension] | None
|
Extensions that cannot be ignored even if unrecognized |
None
|
country
|
CodeableConcept | None
|
The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements |
None
|
jurisdiction
|
CodeableConcept | None
|
Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified |
None
|
status
|
CodeableConcept | None
|
This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples |
None
|
dateRange
|
Period | None
|
The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain |
None
|
restoreDate
|
DateTime | None
|
The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain |
None
|
restoreDate_ext
|
Element | None
|
Placeholder element for restoreDate extensions |
None
|
Meta
Path: fhircraft.fhir.resources.datatypes.R5.complex.meta.Meta
Bases: DataType
Metadata about a resource
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
versionId
|
Id | None
|
Version specific identifier |
None
|
versionId_ext
|
Element | None
|
Placeholder element for versionId extensions |
None
|
lastUpdated
|
Instant | None
|
When the resource version last changed |
None
|
lastUpdated_ext
|
Element | None
|
Placeholder element for lastUpdated extensions |
None
|
source
|
Uri | None
|
Identifies where the resource comes from |
None
|
source_ext
|
Element | None
|
Placeholder element for source extensions |
None
|
profile
|
List[Canonical] | None
|
Profiles this resource claims to conform to |
None
|
profile_ext
|
Element | None
|
Placeholder element for profile extensions |
None
|
security
|
List[Coding] | None
|
Security Labels applied to this resource |
None
|
tag
|
List[Coding] | None
|
Tags applied to this resource |
None
|
MonetaryComponent
Path: fhircraft.fhir.resources.datatypes.R5.complex.monetary_component.MonetaryComponent
Bases: DataType
Availability data for an {item}
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
type
|
Code | None
|
base | surcharge | deduction | discount | tax | informational |
None
|
type_ext
|
Element | None
|
Placeholder element for type extensions |
None
|
code
|
CodeableConcept | None
|
Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. |
None
|
factor
|
Decimal | None
|
Factor used for calculating this component |
None
|
factor_ext
|
Element | None
|
Placeholder element for factor extensions |
None
|
amount
|
Money | None
|
Explicit value amount to be used |
None
|
Money
Path: fhircraft.fhir.resources.datatypes.R5.complex.money.Money
Bases: DataType
An amount of economic utility in some recognized currency
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
value
|
Decimal | None
|
Numerical value (with implicit precision) |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
currency
|
Code | None
|
ISO 4217 Currency Code |
None
|
currency_ext
|
Element | None
|
Placeholder element for currency extensions |
None
|
MoneyQuantity
Path: fhircraft.fhir.resources.datatypes.R5.complex.money_quantity.MoneyQuantity
Bases: Quantity
An amount of money.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
value
|
Decimal | None
|
Numerical value (with implicit precision) |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
comparator
|
Code | None
|
< | <= | >= | > | ad - how to understand the value |
None
|
comparator_ext
|
Element | None
|
Placeholder element for comparator extensions |
None
|
unit
|
String | None
|
Unit representation |
None
|
unit_ext
|
Element | None
|
Placeholder element for unit extensions |
None
|
system
|
Uri | None
|
System that defines coded unit form |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
code
|
Code | None
|
Coded form of the unit |
None
|
code_ext
|
Element | None
|
Placeholder element for code extensions |
None
|
Narrative
Path: fhircraft.fhir.resources.datatypes.R5.complex.narrative.Narrative
Bases: DataType
Human-readable summary of the resource (essential clinical and business information)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
status
|
Code | None
|
generated | extensions | additional | empty |
None
|
status_ext
|
Element | None
|
Placeholder element for status extensions |
None
|
div
|
str | None
|
Limited xhtml content |
None
|
ParameterDefinition
Path: fhircraft.fhir.resources.datatypes.R5.complex.parameter_definition.ParameterDefinition
Bases: DataType
Definition of a parameter to a module
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
name
|
Code | None
|
Name used to access the parameter value |
None
|
name_ext
|
Element | None
|
Placeholder element for name extensions |
None
|
use
|
Code | None
|
in | out |
None
|
use_ext
|
Element | None
|
Placeholder element for use extensions |
None
|
min
|
Integer | None
|
Minimum cardinality |
None
|
min_ext
|
Element | None
|
Placeholder element for min extensions |
None
|
max
|
String | None
|
Maximum cardinality (a number of *) |
None
|
max_ext
|
Element | None
|
Placeholder element for max extensions |
None
|
documentation
|
String | None
|
A brief description of the parameter |
None
|
documentation_ext
|
Element | None
|
Placeholder element for documentation extensions |
None
|
type
|
Code | None
|
What type of value |
None
|
type_ext
|
Element | None
|
Placeholder element for type extensions |
None
|
profile
|
Canonical | None
|
What profile the value is expected to be |
None
|
profile_ext
|
Element | None
|
Placeholder element for profile extensions |
None
|
Period
Path: fhircraft.fhir.resources.datatypes.R5.complex.period.Period
Bases: DataType
Time range defined by start and end date/time
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
start
|
DateTime | None
|
Starting time with inclusive boundary |
None
|
start_ext
|
Element | None
|
Placeholder element for start extensions |
None
|
end
|
DateTime | None
|
End time with inclusive boundary, if not ongoing |
None
|
end_ext
|
Element | None
|
Placeholder element for end extensions |
None
|
PrimitiveType
Path: fhircraft.fhir.resources.datatypes.R5.complex.primitive_type.PrimitiveType
Bases: DataType
Parent type for DataTypes with a simple value
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
ProductShelfLife
Path: fhircraft.fhir.resources.datatypes.R5.complex.product_shelf_life.ProductShelfLife
Bases: BackboneType
The shelf-life and storage information for a medicinal product item or container can be described using this class
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
modifierExtension
|
List[Extension] | None
|
Extensions that cannot be ignored even if unrecognized |
None
|
type
|
CodeableConcept | None
|
This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified |
None
|
periodDuration
|
Duration | None
|
The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used |
None
|
periodString
|
String | None
|
The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used |
None
|
specialPrecautionsForStorage
|
List[CodeableConcept] | None
|
Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified |
None
|
Quantity
Path: fhircraft.fhir.resources.datatypes.R5.complex.quantity.Quantity
Bases: DataType
A measured or measurable amount
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
value
|
Decimal | None
|
Numerical value (with implicit precision) |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
comparator
|
Code | None
|
< | <= | >= | > | ad - how to understand the value |
None
|
comparator_ext
|
Element | None
|
Placeholder element for comparator extensions |
None
|
unit
|
String | None
|
Unit representation |
None
|
unit_ext
|
Element | None
|
Placeholder element for unit extensions |
None
|
system
|
Uri | None
|
System that defines coded unit form |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
code
|
Code | None
|
Coded form of the unit |
None
|
code_ext
|
Element | None
|
Placeholder element for code extensions |
None
|
Range
Path: fhircraft.fhir.resources.datatypes.R5.complex.range.Range
Bases: DataType
Set of values bounded by low and high
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
low
|
Quantity | None
|
Low limit |
None
|
high
|
Quantity | None
|
High limit |
None
|
Ratio
Path: fhircraft.fhir.resources.datatypes.R5.complex.ratio.Ratio
Bases: DataType
A ratio of two Quantity values - a numerator and a denominator
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
numerator
|
Quantity | None
|
Numerator value |
None
|
denominator
|
Quantity | None
|
Denominator value |
None
|
RatioRange
Path: fhircraft.fhir.resources.datatypes.R5.complex.ratio_range.RatioRange
Bases: DataType
Range of ratio values
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
lowNumerator
|
Quantity | None
|
Low Numerator limit |
None
|
highNumerator
|
Quantity | None
|
High Numerator limit |
None
|
denominator
|
Quantity | None
|
Denominator value |
None
|
Reference
Path: fhircraft.fhir.resources.datatypes.R5.complex.reference.Reference
Bases: DataType
A reference from one resource to another
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
reference
|
String | None
|
Literal reference, Relative, internal or absolute URL |
None
|
reference_ext
|
Element | None
|
Placeholder element for reference extensions |
None
|
type
|
Uri | None
|
Type the reference refers to (e.g. "Patient") - must be a resource in resources |
None
|
type_ext
|
Element | None
|
Placeholder element for type extensions |
None
|
identifier
|
Identifier | None
|
Logical reference, when literal reference is not known |
None
|
display
|
String | None
|
Text alternative for the resource |
None
|
display_ext
|
Element | None
|
Placeholder element for display extensions |
None
|
RelatedArtifact
Path: fhircraft.fhir.resources.datatypes.R5.complex.related_artifact.RelatedArtifact
Bases: DataType
Related artifacts for a knowledge resource
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
type
|
Code | None
|
documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as |
None
|
type_ext
|
Element | None
|
Placeholder element for type extensions |
None
|
classifier
|
List[CodeableConcept] | None
|
Additional classifiers |
None
|
label
|
String | None
|
Short label |
None
|
label_ext
|
Element | None
|
Placeholder element for label extensions |
None
|
display
|
String | None
|
Brief description of the related artifact |
None
|
display_ext
|
Element | None
|
Placeholder element for display extensions |
None
|
citation
|
Markdown | None
|
Bibliographic citation for the artifact |
None
|
citation_ext
|
Element | None
|
Placeholder element for citation extensions |
None
|
document
|
Attachment | None
|
What document is being referenced |
None
|
resource
|
Canonical | None
|
What artifact is being referenced |
None
|
resource_ext
|
Element | None
|
Placeholder element for resource extensions |
None
|
resourceReference
|
Reference | None
|
What artifact, if not a conformance resource |
None
|
publicationStatus
|
Code | None
|
draft | active | retired | unknown |
None
|
publicationStatus_ext
|
Element | None
|
Placeholder element for publicationStatus extensions |
None
|
publicationDate
|
Date | None
|
Date of publication of the artifact being referred to |
None
|
publicationDate_ext
|
Element | None
|
Placeholder element for publicationDate extensions |
None
|
Resource
Path: fhircraft.fhir.resources.datatypes.R5.complex.resource.Resource
Bases: Base
Base Resource
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Logical id of this artifact |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
meta
|
Meta | None
|
Metadata about the resource |
None
|
implicitRules
|
Uri | None
|
A set of rules under which this content was created |
None
|
implicitRules_ext
|
Element | None
|
Placeholder element for implicitRules extensions |
None
|
language
|
Code | None
|
Language of the resource content |
None
|
language_ext
|
Element | None
|
Placeholder element for language extensions |
None
|
SampledData
Path: fhircraft.fhir.resources.datatypes.R5.complex.sampled_data.SampledData
Bases: DataType
A series of measurements taken by a device
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
origin
|
Quantity | None
|
Zero value and units |
None
|
interval
|
Decimal | None
|
Number of intervalUnits between samples |
None
|
interval_ext
|
Element | None
|
Placeholder element for interval extensions |
None
|
intervalUnit
|
Code | None
|
The measurement unit of the interval between samples |
None
|
intervalUnit_ext
|
Element | None
|
Placeholder element for intervalUnit extensions |
None
|
factor
|
Decimal | None
|
Multiply data by this before adding to origin |
None
|
factor_ext
|
Element | None
|
Placeholder element for factor extensions |
None
|
lowerLimit
|
Decimal | None
|
Lower limit of detection |
None
|
lowerLimit_ext
|
Element | None
|
Placeholder element for lowerLimit extensions |
None
|
upperLimit
|
Decimal | None
|
Upper limit of detection |
None
|
upperLimit_ext
|
Element | None
|
Placeholder element for upperLimit extensions |
None
|
dimensions
|
PositiveInt | None
|
Number of sample points at each time point |
None
|
dimensions_ext
|
Element | None
|
Placeholder element for dimensions extensions |
None
|
codeMap
|
Canonical | None
|
Defines the codes used in the data |
None
|
codeMap_ext
|
Element | None
|
Placeholder element for codeMap extensions |
None
|
offsets
|
String | None
|
Offsets, typically in time, at which data values were taken |
None
|
offsets_ext
|
Element | None
|
Placeholder element for offsets extensions |
None
|
data
|
String | None
|
Decimal values with spaces, or "E" | "U" | "L", or another code |
None
|
data_ext
|
Element | None
|
Placeholder element for data extensions |
None
|
Signature
Path: fhircraft.fhir.resources.datatypes.R5.complex.signature.Signature
Bases: DataType
A Signature - XML DigSig, JWS, Graphical image of signature, etc.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
type
|
List[Coding] | None
|
Indication of the reason the entity signed the object(s) |
None
|
when
|
Instant | None
|
When the signature was created |
None
|
when_ext
|
Element | None
|
Placeholder element for when extensions |
None
|
who
|
Reference | None
|
Who signed |
None
|
onBehalfOf
|
Reference | None
|
The party represented |
None
|
targetFormat
|
Code | None
|
The technical format of the signed resources |
None
|
targetFormat_ext
|
Element | None
|
Placeholder element for targetFormat extensions |
None
|
sigFormat
|
Code | None
|
The technical format of the signature |
None
|
sigFormat_ext
|
Element | None
|
Placeholder element for sigFormat extensions |
None
|
data
|
Base64Binary | None
|
The actual signature content (XML DigSig. JWS, picture, etc.) |
None
|
data_ext
|
Element | None
|
Placeholder element for data extensions |
None
|
SimpleQuantity
Path: fhircraft.fhir.resources.datatypes.R5.complex.simple_quantity.SimpleQuantity
Bases: Quantity
A fixed quantity (no comparator)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
value
|
Decimal | None
|
Numerical value (with implicit precision) |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|
comparator
|
Code | None
|
< | <= | >= | > | ad - how to understand the value |
None
|
comparator_ext
|
Element | None
|
Placeholder element for comparator extensions |
None
|
unit
|
String | None
|
Unit representation |
None
|
unit_ext
|
Element | None
|
Placeholder element for unit extensions |
None
|
system
|
Uri | None
|
System that defines coded unit form |
None
|
system_ext
|
Element | None
|
Placeholder element for system extensions |
None
|
code
|
Code | None
|
Coded form of the unit |
None
|
code_ext
|
Element | None
|
Placeholder element for code extensions |
None
|
Timing
Path: fhircraft.fhir.resources.datatypes.R5.complex.timing.Timing
Bases: BackboneType
A timing schedule that specifies an event that may occur multiple times
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
modifierExtension
|
List[Extension] | None
|
Extensions that cannot be ignored even if unrecognized |
None
|
event
|
List[DateTime] | None
|
When the event occurs |
None
|
event_ext
|
Element | None
|
Placeholder element for event extensions |
None
|
repeat
|
Element | None
|
When the event is to occur |
None
|
code
|
CodeableConcept | None
|
C | BID | TID | QID | AM | PM | QD | QOD | + |
None
|
TriggerDefinition
Path: fhircraft.fhir.resources.datatypes.R5.complex.trigger_definition.TriggerDefinition
Bases: DataType
Defines an expected trigger for a module
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
type
|
Code | None
|
named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended |
None
|
type_ext
|
Element | None
|
Placeholder element for type extensions |
None
|
name
|
String | None
|
Name or URI that identifies the event |
None
|
name_ext
|
Element | None
|
Placeholder element for name extensions |
None
|
code
|
CodeableConcept | None
|
Coded definition of the event |
None
|
subscriptionTopic
|
Canonical | None
|
What event |
None
|
subscriptionTopic_ext
|
Element | None
|
Placeholder element for subscriptionTopic extensions |
None
|
timingTiming
|
Timing | None
|
Timing of the event |
None
|
timingReference
|
Reference | None
|
Timing of the event |
None
|
timingDate
|
Date | None
|
Timing of the event |
None
|
timingDateTime
|
DateTime | None
|
Timing of the event |
None
|
data
|
List[DataRequirement] | None
|
Triggering data of the event (multiple = 'and') |
None
|
condition
|
Expression | None
|
Whether the event triggers (boolean expression) |
None
|
UsageContext
Path: fhircraft.fhir.resources.datatypes.R5.complex.usage_context.UsageContext
Bases: DataType
Describes the context of use for a conformance or knowledge resource
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
code
|
Coding | None
|
Type of context being specified |
None
|
valueCodeableConcept
|
CodeableConcept | None
|
Value that defines the context |
None
|
valueQuantity
|
Quantity | None
|
Value that defines the context |
None
|
valueRange
|
Range | None
|
Value that defines the context |
None
|
valueReference
|
Reference | None
|
Value that defines the context |
None
|
VirtualServiceDetail
Path: fhircraft.fhir.resources.datatypes.R5.complex.virtual_service_detail.VirtualServiceDetail
Bases: DataType
Virtual Service Contact Details
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
channelType
|
Coding | None
|
Channel Type |
None
|
addressUrl
|
Url | None
|
Contact address/number |
None
|
addressString
|
String | None
|
Contact address/number |
None
|
addressContactPoint
|
ContactPoint | None
|
Contact address/number |
None
|
addressExtendedContactDetail
|
ExtendedContactDetail | None
|
Contact address/number |
None
|
additionalInfo
|
List[Url] | None
|
Address to see alternative connection details |
None
|
additionalInfo_ext
|
Element | None
|
Placeholder element for additionalInfo extensions |
None
|
maxParticipants
|
PositiveInt | None
|
Maximum number of participants supported by the virtual service |
None
|
maxParticipants_ext
|
Element | None
|
Placeholder element for maxParticipants extensions |
None
|
sessionKey
|
String | None
|
Session Key required by the virtual service |
None
|
sessionKey_ext
|
Element | None
|
Placeholder element for sessionKey extensions |
None
|
xhtml
Path: fhircraft.fhir.resources.datatypes.R5.complex.xhtml.xhtml
Bases: Element
Primitive Type xhtml
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
String | None
|
Unique id for inter-element referencing |
None
|
id_ext
|
Element | None
|
Placeholder element for id extensions |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
value
|
String | None
|
Actual xhtml |
None
|
value_ext
|
Element | None
|
Placeholder element for value extensions |
None
|