Class PatientContactComponent

PatientContactComponent Class

Remarks

FHIR Specification

Short: A contact party (e.g. guardian, partner, friend) for the patient
Definition: A contact party (e.g. guardian, partner, friend) for the patient.
Comment: Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.
Requirements: Need to track people you can contact about the patient.

See

FHIR Patient

Hierarchy (View Summary)

BackboneElement
- PatientContactComponent

Implements

IBackboneElement

Index

Constructors

constructor

new PatientContactComponent(): PatientContactComponent
Returns PatientContactComponent
Overrides BackboneElement.constructor
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:1826

Properties

`Private` `Optional`relationship

relationship?: CodeableConcept[]

Patient.contact.relationship Element

Remarks

FHIR Specification

Short: The kind of relationship
Definition: The nature of the relationship between the patient and the contact person.
Requirements: Used to determine which contact person is the most relevant to approach, depending on circumstances.
FHIR Type: CodeableConcept
Cardinality: 0..*
isModifier: false
isSummary: false

`Private` `Optional`name

name?: HumanName

Patient.contact.name Element

Remarks

FHIR Specification

Short: A name associated with the contact person
Definition: A name associated with the contact person.
Requirements: Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
FHIR Type: HumanName
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`telecom

telecom?: ContactPoint[]

Patient.contact.telecom Element

Remarks

FHIR Specification

Short: A contact detail for the person
Definition: A contact detail for the person, e.g. a telephone number or an email address.
Comment: Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.
Requirements: People have (primary) ways to contact them in some way such as phone, email.
FHIR Type: ContactPoint
Cardinality: 0..*
isModifier: false
isSummary: false

`Private` `Optional`address

address?: Address

Patient.contact.address Element

Remarks

FHIR Specification

Short: Address for the contact person
Definition: Address for the contact person.
Requirements: Need to keep track where the contact person can be contacted per postal mail or visited.
FHIR Type: Address
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Readonly`administrativeGenderEnum

administrativeGenderEnum: AdministrativeGenderEnum

FHIR CodeSystem: AdministrativeGender

See

AdministrativeGenderEnum

`Private` `Optional`gender

gender?: EnumCodeType

Patient.contact.gender Element

Remarks

FHIR Specification

Short: male | female | other | unknown
Definition: Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
Requirements: Needed to address the person correctly.
FHIR Type: code
Cardinality: 0..1
isModifier: false
isSummary: false

See

CodeSystem Enumeration: AdministrativeGenderEnum

`Private` `Optional`organization

organization?: Reference

Patient.contact.organization Element

Remarks

FHIR Specification

Short: Organization that is associated with the contact
Definition: Organization on behalf of which the contact is acting or for which the contact is working.
Requirements: For guardians or business related contacts, the organization is relevant.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/Organization', ]
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`period

period?: Period

Patient.contact.period Element

Remarks

FHIR Specification

Short: The period during which this contact person or organization is valid to be contacted relating to this patient
Definition: The period during which this contact person or organization is valid to be contacted relating to this patient.
FHIR Type: Period
Cardinality: 0..1
isModifier: false
isSummary: false

Methods

`Static`parse

parse(
sourceJson: Value,
optSourceField?: string,
): undefined | PatientContactComponent
Parse the provided PatientContactComponent JSON to instantiate the PatientContactComponent data model.
Parameters
- sourceJson: Value
  JSON representing FHIR PatientContactComponent
- OptionaloptSourceField: string
  Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to PatientContactComponent
Returns undefined | PatientContactComponent
PatientContactComponent data model or undefined for PatientContactComponent

Throws
JsonError if the provided JSON is not a valid JSON object
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:1840

getRelationship

getRelationship(): CodeableConcept[]
Returns CodeableConcept[]
the relationship property value as a CodeableConcept array
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2052

setRelationship

setRelationship(value: undefined | CodeableConcept[]): this
Assigns the provided CodeableConcept array value to the relationship property.
Parameters
- value: undefined | CodeableConcept[]
  the relationship array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2063

addRelationship

addRelationship(value: undefined | CodeableConcept): this
Add the provided CodeableConcept value to the relationship array property.
Parameters
- value: undefined | CodeableConcept
  the relationship value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2081

hasRelationship

hasRelationship(): boolean
Returns boolean
true if the relationship property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2094

getName

getName(): HumanName
Returns HumanName
the name property value as a HumanName object if defined; else an empty HumanName object
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2110

setName

setName(value: undefined | HumanName): this
Assigns the provided Name object value to the name property.
Parameters
- value: undefined | HumanName
  the name object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2121

hasName

hasName(): boolean
Returns boolean
true if the name property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2135

getTelecom

getTelecom(): ContactPoint[]
Returns ContactPoint[]
the telecom property value as a ContactPoint array
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2142

setTelecom

setTelecom(value: undefined | ContactPoint[]): this
Assigns the provided ContactPoint array value to the telecom property.
Parameters
- value: undefined | ContactPoint[]
  the telecom array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2153

addTelecom

addTelecom(value: undefined | ContactPoint): this
Add the provided ContactPoint value to the telecom array property.
Parameters
- value: undefined | ContactPoint
  the telecom value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2171

hasTelecom

hasTelecom(): boolean
Returns boolean
true if the telecom property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2184

getAddress

getAddress(): Address
Returns Address
the address property value as a Address object if defined; else an empty Address object
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2200

setAddress

setAddress(value: undefined | Address): this
Assigns the provided Address object value to the address property.
Parameters
- value: undefined | Address
  the address object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2211

hasAddress

hasAddress(): boolean
Returns boolean
true if the address property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2225

getGenderEnumType

getGenderEnumType(): undefined | EnumCodeType
Returns undefined | EnumCodeType
the gender property value as a EnumCodeType if defined; else undefined

See
CodeSystem Enumeration: AdministrativeGenderEnum
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2234

setGenderEnumType

setGenderEnumType(enumType: undefined | EnumCodeType): this
Assigns the provided EnumCodeType value to the gender property.
Parameters
- enumType: undefined | EnumCodeType
  the gender value
Returns this
this

Throws
InvalidCodeError for invalid code values

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: AdministrativeGenderEnum
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2248

hasGenderEnumType

hasGenderEnumType(): boolean
Returns boolean
true if the gender property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2262

getGenderElement

getGenderElement(): undefined | CodeType
Returns undefined | CodeType
the gender property value as a CodeType if defined; else undefined

See
CodeSystem Enumeration: AdministrativeGenderEnum
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2271

setGenderElement

setGenderElement(element: undefined | CodeType): this
Assigns the provided PrimitiveType value to the gender property.
Parameters
- element: undefined | CodeType
  the gender value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: AdministrativeGenderEnum
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2288

hasGenderElement

hasGenderElement(): boolean
Returns boolean
true if the gender property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2302

getGender

getGender(): undefined | string
Returns undefined | string
the gender property value as a fhirCode if defined; else undefined

See
CodeSystem Enumeration: AdministrativeGenderEnum
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2311

setGender

setGender(value: undefined | string): this
Assigns the provided primitive value to the gender property.
Parameters
- value: undefined | string
  the gender value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: AdministrativeGenderEnum
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2328

hasGender

hasGender(): boolean
Returns boolean
true if the gender property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2341

getOrganization

getOrganization(): Reference
Returns Reference
the organization property value as a Reference object; else an empty Reference object
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2348

setOrganization

setOrganization(value: undefined | Reference): this
Assigns the provided Organization object value to the organization property.
Parameters
- value: undefined | Reference
  the organization object value
Returns this
this

Decorator
@ReferenceTargets('Patient.contact.organization', ['Organization',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2364

hasOrganization

hasOrganization(): boolean
Returns boolean
true if the organization property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2377

getPeriod

getPeriod(): Period
Returns Period
the period property value as a Period object if defined; else an empty Period object
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2384

setPeriod

setPeriod(value: undefined | Period): this
Assigns the provided Period object value to the period property.
Parameters
- value: undefined | Period
  the period object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2395

hasPeriod

hasPeriod(): boolean
Returns boolean
true if the period property exists and has a value; false otherwise
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2409

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IBackboneElement.fhirType
Overrides BackboneElement.fhirType
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2418

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IBackboneElement.isEmpty
Overrides BackboneElement.isEmpty
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2425

copy

copy(): PatientContactComponent
Creates a copy of the current instance.

Returns PatientContactComponent
the a new instance copied from the current instance
Implementation of IBackboneElement.copy
Overrides BackboneElement.copy
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2442

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IBackboneElement.toJSON
Overrides BackboneElement.toJSON
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2470

getModifierExtension

getModifierExtension(): IExtension[]
Returns IExtension[]
the array of modifierExtension values
Implementation of IBackboneElement.getModifierExtension
Inherited from BackboneElement.getModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:195

setModifierExtension

setModifierExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the modifierExtension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setModifierExtension
Inherited from BackboneElement.setModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:202

hasModifierExtension

hasModifierExtension(url?: string): boolean
Determines if the modifierExtension property exists.
Parameters
- Optionalurl: string
  the url that identifies a specific Extension
Returns boolean
true if an Extension has the provided url; false otherwise

Remarks
If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasModifierExtension
Inherited from BackboneElement.hasModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:214

getModifierExtensionByUrl

getModifierExtensionByUrl(url: string): undefined | IExtension
Returns the Extension having the provided url.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
the Extension having the provided url

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getModifierExtensionByUrl
Inherited from BackboneElement.getModifierExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:222

addModifierExtension

addModifierExtension(extension: undefined | IExtension): this
Adds the provided Extension to the modifierExtension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the modifierExtension property array
Returns this
this
Implementation of IBackboneElement.addModifierExtension
Inherited from BackboneElement.addModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:229

removeModifierExtension

removeModifierExtension(url: string): void
Removes the Extension having the provided url from the modifierExtension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeModifierExtension
Inherited from BackboneElement.removeModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:236

getId

getId(): undefined | string
Returns undefined | string
the id property value
Implementation of IBackboneElement.getId
Inherited from BackboneElement.getId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:59

setId

setId(value: undefined | string): this
Assigns the provided value to the id property.
Parameters
- value: undefined | string
  the id value
Returns this
this

Throws
PrimitiveTypeError for invalid value
Implementation of IBackboneElement.setId
Inherited from BackboneElement.setId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:67

hasId

hasId(): boolean
Returns boolean
true if id exists and has a value; false otherwise
Implementation of IBackboneElement.hasId
Inherited from BackboneElement.hasId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:71

getExtension

getExtension(): IExtension[]
Returns IExtension[]
the array of extension values
Implementation of IBackboneElement.getExtension
Inherited from BackboneElement.getExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:75

setExtension

setExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the extension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setExtension
Inherited from BackboneElement.setExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:82

hasExtension

hasExtension(url?: string): boolean
Determines if the extension property exists.
Parameters
- Optionalurl: string
  the url that identifies a specific Extension
Returns boolean
true if an Extension has the provided url; false otherwise

Remarks
If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasExtension
Inherited from BackboneElement.hasExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:94

getExtensionByUrl

getExtensionByUrl(url: string): undefined | IExtension
Determines if the extension property exists.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
an Extension having the provided url

Remarks
If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getExtensionByUrl
Inherited from BackboneElement.getExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:106

addExtension

addExtension(extension: undefined | IExtension): this
Adds the provided Extension to the extension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the extension property array
Returns this
this
Implementation of IBackboneElement.addExtension
Inherited from BackboneElement.addExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:113

removeExtension

removeExtension(url: string): void
Removes the Extension having the provided url from the extension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeExtension
Inherited from BackboneElement.removeExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:120

isRequiredFieldsEmpty

isRequiredFieldsEmpty(): boolean
Returns boolean
true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise
Implementation of IBackboneElement.isRequiredFieldsEmpty
Inherited from BackboneElement.isRequiredFieldsEmpty
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:63

isResource

isResource(): boolean
Returns boolean
true if the instance is a FHIR resource; false otherwise
Implementation of IBackboneElement.isResource
Inherited from BackboneElement.isResource
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:67

isDataType

isDataType(): boolean
Returns boolean
true if the instance is a FHIR complex or primitive datatype; false otherwise
Implementation of IBackboneElement.isDataType
Inherited from BackboneElement.isDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:71

isComplexDataType

isComplexDataType(): boolean
Returns boolean
true if the instance is a FHIR complex datatype; false otherwise
Implementation of IBackboneElement.isComplexDataType
Inherited from BackboneElement.isComplexDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:75

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datatype; false otherwise
Implementation of IBackboneElement.isPrimitive
Inherited from BackboneElement.isPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:79

isBooleanPrimitive

isBooleanPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive boolean datatype; false otherwise
Implementation of IBackboneElement.isBooleanPrimitive
Inherited from BackboneElement.isBooleanPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:83

isStringPrimitive

isStringPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive string-based datatype; false otherwise
Implementation of IBackboneElement.isStringPrimitive
Inherited from BackboneElement.isStringPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:87

isNumberPrimitive

isNumberPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive number-based datatype; false otherwise
Implementation of IBackboneElement.isNumberPrimitive
Inherited from BackboneElement.isNumberPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:91

isBigIntPrimitive

isBigIntPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
Implementation of IBackboneElement.isBigIntPrimitive
Inherited from BackboneElement.isBigIntPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:95

isDateTimePrimitive

isDateTimePrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
Implementation of IBackboneElement.isDateTimePrimitive
Inherited from BackboneElement.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: PatientContactComponent): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: PatientContactComponent
  the copied instance
Returns void
Overrides BackboneElement.copyValues
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2454

`Private`initRelationship

initRelationship(): void
Initialize the relationship property

Returns void
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2101

`Private`initTelecom

initTelecom(): void
Initialize the telecom property

Returns void
- Defined in packages/r4b-datamodels/src/resources/Patient.ts:2191

Class PatientContactComponent

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PatientContactComponent

Properties

Private Optionalrelationship

Remarks

Private Optionalname

Remarks

Private Optionaltelecom

Remarks

Private Optionaladdress

Remarks

Private ReadonlyadministrativeGenderEnum

See

Private Optionalgender

Remarks

See

Private Optionalorganization

Remarks

Private Optionalperiod

Remarks

Methods

Staticparse

Parameters

Returns undefined | PatientContactComponent

Throws

getRelationship

Returns CodeableConcept[]

setRelationship

Parameters

Returns this

Throws

addRelationship

Parameters

Returns this

Throws

hasRelationship

Returns boolean

getName

Returns HumanName

setName

Parameters

Returns this

Throws

hasName

Returns boolean

getTelecom

Returns ContactPoint[]

setTelecom

Parameters

Returns this

Throws

addTelecom

Parameters

Returns this

Throws

hasTelecom

Returns boolean

getAddress

Returns Address

setAddress

Parameters

Returns this

Throws

hasAddress

Returns boolean

getGenderEnumType

Returns undefined | EnumCodeType

See

setGenderEnumType

Parameters

`Private` `Optional`relationship

`Private` `Optional`name

`Private` `Optional`telecom

`Private` `Optional`address

`Private` `Readonly`administrativeGenderEnum

`Private` `Optional`gender

`Private` `Optional`organization

`Private` `Optional`period

`Static`parse