FHIR R4 Primitive Types¶
Classes representing FHIR R4 primitive types.
primitive ¶
Modules:
| Name | Description |
|---|---|
base64_binary |
|
boolean |
|
canonical |
|
code |
|
date |
|
date_time |
|
decimal |
|
id |
|
instant |
|
integer |
|
markdown |
|
oid |
|
positive_int |
|
string |
|
time |
|
unsigned_int |
|
uri |
|
url |
|
uuid |
|
xhtml |
|
Classes:
| Name | Description |
|---|---|
String |
A sequence of Unicode characters. |
Id |
Any combination of letters, numerals, '-' and '.', with a length limit of 64 characters. |
Boolean |
Value of 'true' or 'false'. |
Canonical |
A URI that refers to a resource by its canonical URL. |
Code |
A string which has at least one character and no leading/trailing whitespace. |
Date |
A date, or partial date. |
DateTime |
A date, date-time or partial date. |
Decimal |
A rational number. |
Instant |
An instant in time in the format YYYY-MM-DDThh |
Integer |
A signed integer in the range -2,147,483,648..2,147,483,647. |
Markdown |
A string that may contain Github Flavored Markdown syntax. |
Oid |
An OID represented as a URI. |
PositiveInt |
An integer with a value greater than 0. |
Time |
A time during the day. |
UnsignedInt |
An integer with a value in the range 0..2,147,483,647. |
Uri |
A Uniform Resource Identifier Reference. |
Url |
A Uniform Resource Locator. |
Uuid |
A UUID represented as a URI. |
Base64Binary |
A stream of bytes, base64 encoded. |
Xhtml |
A string of XHTML content. |
String
Path: fhircraft.fhir.resources.datatypes.R4.primitive.String
String(__value: Any | None = None, **data)
Bases: Element, StringBase
A sequence of Unicode characters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str | None
|
The actual string value. |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Id
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Id
Id(__value: Any | None = None, **data)
Any combination of letters, numerals, '-' and '.', with a length limit of 64 characters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Boolean
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Boolean
Boolean(__value: Any | None = None, **data)
Bases: Element, BooleanBase
Value of 'true' or 'false'.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Canonical
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Canonical
Canonical(__value: Any | None = None, **data)
Bases: Uri, CanonicalBase
A URI that refers to a resource by its canonical URL.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Code
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Code
Code(__value: Any | None = None, **data)
A string which has at least one character and no leading/trailing whitespace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Date
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Date
Date(__value: Any | None = None, **data)
DateTime
Path: fhircraft.fhir.resources.datatypes.R4.primitive.DateTime
DateTime(__value: Any | None = None, **data)
Bases: Element, DateTimeBase
A date, date-time or partial date.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Decimal
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Decimal
Decimal(__value: Any | None = None, **data)
Bases: Element, DecimalBase
A rational number.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Instant
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Instant
Instant(__value: Any | None = None, **data)
Bases: Element, InstantBase
An instant in time in the format YYYY-MM-DDThh
ss.sss+zz:zz.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Integer
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Integer
Integer(__value: Any | None = None, **data)
Bases: Element, IntegerBase
A signed integer in the range -2,147,483,648..2,147,483,647.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Markdown
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Markdown
Markdown(__value: Any | None = None, **data)
Bases: String, MarkdownBase
A string that may contain Github Flavored Markdown syntax.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Oid
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Oid
Oid(__value: Any | None = None, **data)
PositiveInt
Path: fhircraft.fhir.resources.datatypes.R4.primitive.PositiveInt
PositiveInt(__value: Any | None = None, **data)
Bases: Integer, PositiveIntBase
An integer with a value greater than 0.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Time
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Time
Time(__value: Any | None = None, **data)
UnsignedInt
Path: fhircraft.fhir.resources.datatypes.R4.primitive.UnsignedInt
UnsignedInt(__value: Any | None = None, **data)
Bases: Integer, UnsignedIntBase
An integer with a value in the range 0..2,147,483,647.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|
Uri
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Uri
Uri(__value: Any | None = None, **data)
Url
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Url
Url(__value: Any | None = None, **data)
Uuid
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Uuid
Uuid(__value: Any | None = None, **data)
Base64Binary
Path: fhircraft.fhir.resources.datatypes.R4.primitive.Base64Binary
Base64Binary(__value: Any | None = None, **data)
Bases: Element, Base64BinaryBase
A stream of bytes, base64 encoded.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str | None
|
The actual value |
None
|
id
|
str | None
|
Unique id for inter-element referencing |
None
|
extension
|
List[Extension] | None
|
Additional content defined by implementations |
None
|