FHIR R5 Primitive Types

Classes representing FHIR R5 primitive types.

Base64Binary

Path: fhircraft.fhir.resources.datatypes.R5.primitive.base64_binary.Base64Binary

Base64Binary(__value: Any | None = None, **data)

Bases: PrimitiveType, 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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Boolean

Path: fhircraft.fhir.resources.datatypes.R5.primitive.boolean.Boolean

Boolean(__value: Any | None = None, **data)

Bases: PrimitiveType, 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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Canonical

Path: fhircraft.fhir.resources.datatypes.R5.primitive.canonical.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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Code

Path: fhircraft.fhir.resources.datatypes.R5.primitive.code.Code

Code(__value: Any | None = None, **data)

Bases: String, CodeBase

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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Date

Path: fhircraft.fhir.resources.datatypes.R5.primitive.date.Date

Date(__value: Any | None = None, **data)

Bases: PrimitiveType, DateBase

A date, 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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

DateTime

Path: fhircraft.fhir.resources.datatypes.R5.primitive.date_time.DateTime

DateTime(__value: Any | None = None, **data)

Bases: PrimitiveType, 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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Decimal

Path: fhircraft.fhir.resources.datatypes.R5.primitive.decimal.Decimal

Decimal(__value: Any | None = None, **data)

Bases: PrimitiveType, 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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Id

Path: fhircraft.fhir.resources.datatypes.R5.primitive.id.Id

Id(__value: Any | None = None, **data)

Bases: String, IdBase

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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Instant

Path: fhircraft.fhir.resources.datatypes.R5.primitive.instant.Instant

Instant(__value: Any | None = None, **data)

Bases: PrimitiveType, InstantBase

An instant in time in the format YYYY-MM-DDThhss.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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Integer

Path: fhircraft.fhir.resources.datatypes.R5.primitive.integer.Integer

Integer(__value: Any | None = None, **data)

Bases: PrimitiveType, 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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Integer64

Path: fhircraft.fhir.resources.datatypes.R5.primitive.integer64.Integer64

Integer64(__value: Any | None = None, **data)

Bases: Integer, Integer64Base

A signed 64-bit integer in the range -9,223,372,036,854,775,808..9,223,372,036,854,775,807.

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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Markdown

Path: fhircraft.fhir.resources.datatypes.R5.primitive.markdown.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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Oid

Path: fhircraft.fhir.resources.datatypes.R5.primitive.oid.Oid

Oid(__value: Any | None = None, **data)

Bases: Uri, OidBase

An OID represented as a URI.

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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

PositiveInt

Path: fhircraft.fhir.resources.datatypes.R5.primitive.positive_int.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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

String

Path: fhircraft.fhir.resources.datatypes.R5.primitive.string.String

String(__value: Any | None = None, **data)

Bases: PrimitiveType, 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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Time

Path: fhircraft.fhir.resources.datatypes.R5.primitive.time.Time

Time(__value: Any | None = None, **data)

Bases: PrimitiveType, TimeBase

A time during the day.

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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

UnsignedInt

Path: fhircraft.fhir.resources.datatypes.R5.primitive.unsigned_int.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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Uri

Path: fhircraft.fhir.resources.datatypes.R5.primitive.uri.Uri

Uri(__value: Any | None = None, **data)

Bases: String, UriBase

A Uniform Resource Identifier Reference.

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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Url

Path: fhircraft.fhir.resources.datatypes.R5.primitive.url.Url

Url(__value: Any | None = None, **data)

Bases: Uri, UrlBase

A Uniform Resource Locator.

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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Uuid

Path: fhircraft.fhir.resources.datatypes.R5.primitive.uuid.Uuid

Uuid(__value: Any | None = None, **data)

Bases: Uri, UuidBase

A UUID represented as a URI.

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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)

Xhtml

Path: fhircraft.fhir.resources.datatypes.R5.primitive.xhtml.Xhtml

Xhtml(__value: Any | None = None, **data)

Bases: PrimitiveType, XhtmlBase

A string of XHTML content.

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

Source code in fhircraft/fhir/resources/base/primitives.py

def __init__(self, __value: Any | None = None, **data):
    if __value is not None:
        data.setdefault("value", __value)
    super().__init__(**data)