FhirEx.Resources.Organization (fhir_ex v0.2.0)

Copy Markdown View Source

FHIR R5 Organization resource.

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action.

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

Example

alias FhirEx.Resources.Organization
alias FhirEx.Types.{Identifier, ContactPoint, Address, CodeableConcept, Coding}

org = %Organization{
  id: "org-001",
  identifier: [
    %Identifier{system: "http://hl7.org/fhir/sid/us-npi", value: "0987654321"}
  ],
  active: true,
  type: [
    %CodeableConcept{
      coding: [%Coding{system: "http://terminology.hl7.org/CodeSystem/organization-type", code: "prov"}],
      text: "Healthcare Provider"
    }
  ],
  name: "General Hospital"
}

Summary

Types

contact()
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.

resource_type()

Returns the FHIR resource type name string.

to_map(o)

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

Types

contact()

@type contact() :: %{
  purpose: FhirEx.Types.CodeableConcept.t() | nil,
  name: map() | nil,
  telecom: [FhirEx.Types.ContactPoint.t()] | nil,
  address: FhirEx.Types.Address.t() | nil
}

t()

@type t() :: %FhirEx.Resources.Organization{
  active: boolean() | nil,
  address: [FhirEx.Types.Address.t()] | nil,
  alias: [String.t()] | nil,
  contact: [contact()] | nil,
  description: String.t() | nil,
  endpoint: [FhirEx.Types.Reference.t()] | nil,
  extension: [FhirEx.Types.Extension.t()] | nil,
  id: String.t() | nil,
  identifier: [FhirEx.Types.Identifier.t()] | nil,
  meta: FhirEx.Types.Meta.t() | nil,
  name: String.t() | nil,
  part_of: FhirEx.Types.Reference.t() | nil,
  telecom: [FhirEx.Types.ContactPoint.t()] | nil,
  text: FhirEx.Types.Narrative.t() | nil,
  type: [FhirEx.Types.CodeableConcept.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.

resource_type()

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

Returns the FHIR resource type name string.

to_map(o)

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

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