Options
All
  • Public
  • Public/Protected
  • All
Menu

Module fhir

Module containing interfaces for all used FHIR resources in accordance with FHIR version 3.5.0

Index

Interfaces

Type aliases

Type aliases

AddressType

AddressType: "postal" | "physical" | "both"

All possible values for Address.type

AddressUse

AddressUse: "home" | "work" | "temp" | "old"

All possible values for Address.use

CarePlanIntent

CarePlanIntent: "proposal" | "plan" | "order" | "option"

All possible values for CarePlan.intent

CarePlanStatus

CarePlanStatus: "draft" | "active" | "suspended" | "completed" | "entered-in-error" | "cancelled" | "unknown"

All possible values for CarePlan.status

ContactPointSystem

ContactPointSystem: "phone" | "fax" | "email" | "pager" | "url" | "sms" | "other"

All possible values of ContactPoint.system

ContactPointUse

ContactPointUse: "home" | "work" | "temp" | "old" | "mobile"

All possible values of ContactPoint.use

HumanNameUse

HumanNameUse: "usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden"

All possible values of HumanName.use

IdentifierUse

IdentifierUse: "usual" | "official" | "temp" | "secondary"

All possible values of Identifier.use

NarrativeStatus

NarrativeStatus: "generated" | "extensions" | "additional" | "empty"

All possible values for Narrative.status

PatientGender

PatientGender: "male" | "female" | "other" | "unknown"

All possible values of Patient.gender

PlanDefinitionStatus

PlanDefinitionStatus: "draft" | "active" | "retired" | "unknown"

All possible values for PlanDefinition.status

QuestionnaireItemEnableBehavior

QuestionnaireItemEnableBehavior: "all" | "any"

QuestionnaireStatus

QuestionnaireStatus: "draft" | "active" | "retired" | "unknown"

TaskIntent

TaskIntent: "unknown" | "proposal" | "plan" | "order" | "original-order" | "reflex-order" | "filler-order" | "instance-order" | "option"

All possible values for Task.intent

TaskStatus

TaskStatus: "draft" | "requested" | "received" | "accepted" | "rejected" | "ready" | "cancelled" | "in-progress" | "on-hold" | "failed" | "completed" | "entered-in-error"

All possible values for Task.status

TaskUrgency

TaskUrgency: "routine" | "urgent" | "asap" | "stat"

All possible values for Task.urgency

base64Binary

base64Binary: string

A stream of bytes, base64 encoded (RFC 4648).

canonical

canonical: uri

A URI that refers to a canonical URI.

code

code: string

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

date

date: string

A date, or partial date (e.g. just year or year + month) as used in human communication. The format is YYYY, YYYY-MM, or YYYY-MM-DD, e.g. 2018, 1973-06, or 1905-08-23. There SHALL be no time zone.

dateTime

dateTime: string

A date, date-time or partial date (e.g. just year or year + month) as used in human communication. The format is YYYY, YYYY-MM, YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+zz:zz, e.g. 2018, 1973-06, 1905-08-23, 2015-02-07T13:28:17-05:00 or 2017-01-01T00:00:00.000Z. If hours and minutes are specified, a time zone SHALL be populated. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored at receiver discretion. Dates SHALL be valid dates.

decimal

decimal: number

Rational numbers that has a decimal representation.

id

id: string
Any combination of upper or lower case ASCII letters ('A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.', with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)

instant

instant: string

An instant in time in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. The time SHALL be specified at least to the second and SHALL include a time zone.

integer

integer: number

A signed integer in the range −2,147,483,648..2,147,483,647 (32-bit; for larger values, use decimal)

markdown

markdown: string

A FHIR string that may contain markdown syntax for optional processing by a markdown presentation engine, in the GFM extension of CommonMark format

oid

oid: string

An OID represented as a URI (RFC 3001 ); e.g. urn:oid:1.2.3.4.5

positiveInt

positiveInt: number

Any positive integer in the range 1..2,147,483,647

time

time: string

A time during the day, in the format hh:mm:ss. There is no date specified. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored at receiver discretion.

unsignedInt

unsignedInt: number
Any non-negative integer in the range 0..2,147,483,647

uri

uri: string

A Uniform Resource Identifier Reference (RFC 3986 ). Note: URIs are case sensitive.

url

url: string

A Uniform Resource Locator (http://tools.ietf.org/html/rfc1738)

uuid

uuid: string

A UUID (aka GUID) represented as a URI (RFC 4122 ); e.g. urn:uuid:c757873d-ec9a-4326-a141-556f43239520

Generated using TypeDoc