FhirEx.Types.Narrative (fhir_ex v0.3.0)

Copy Markdown View Source

FHIR R5 Narrative data type.

A human-readable summary of the resource, in XHTML form. Required for DomainResources when they may be rendered on their own (e.g., in a display system).

https://www.hl7.org/fhir/R5/narrative.html

Status codes: generated | extensions | additional | empty

Summary

Types

t()

Functions

from_map(map)

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

generated(text)

Builds a minimal generated narrative.

new(attrs \\ %{})

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

to_map(n)

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

Types

t()

@type t() :: %FhirEx.Types.Narrative{div: String.t(), status: String.t()}

Functions

from_map(map)

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

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

generated(text)

@spec generated(String.t()) :: t()

Builds a minimal generated narrative.

new(attrs \\ %{})

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

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

to_map(n)

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

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