FhirEx.Types.Address (fhir_ex v0.2.0)

FHIR R5 Address data type.

An address expressed using postal conventions.

https://www.hl7.org/fhir/R5/datatypes.html#Address

Use codes: home | work | temp | old | billing Type codes: postal | physical | both

Summary

Types

t()

Functions

from_map(map)

Builds the struct from a string-keyed map (e.g., from decoded FHIR JSON).

new(attrs \\ %{})

Builds a new struct from a map or keyword list of field values.

to_map(a)

Converts the struct to a string-keyed map for use with FhirEx.JSON.

Types

t()

@type t() :: %FhirEx.Types.Address{
  city: String.t() | nil,
  country: String.t() | nil,
  district: String.t() | nil,
  line: [String.t()] | nil,
  period: FhirEx.Types.Period.t() | nil,
  postal_code: String.t() | nil,
  state: String.t() | nil,
  text: String.t() | nil,
  type: String.t() | nil,
  use: String.t() | nil
}

Functions

from_map(map)

@spec from_map(map()) :: t()

Builds the struct from a string-keyed map (e.g., from decoded FHIR JSON).

new(attrs \\ %{})

@spec new(map() | keyword()) :: t()

Builds a new struct from a map or keyword list of field values.

to_map(a)

@spec to_map(t()) :: map()

Converts the struct to a string-keyed map for use with FhirEx.JSON.