Data Model Libraries
    Preparing search index...

    Class EncounterReasonComponent

    EncounterReasonComponent Class

    FHIR Specification

    • Short: The list of medical reasons that are expected to be addressed during the episode of care
    • Definition: The list of medical reasons that are expected to be addressed during the episode of care.
    • Comment: The reason communicates what medical problem the patient has that should be addressed during the episode of care. This reason could be patient reported complaint, a clinical indication that was determined in a previous encounter or episode of care, or some planned care such as an immunization recommendation. In the case where you have a primary reason, but are expecting to also address other problems, you can list the primary reason with a use code of 'Chief Complaint', while the other problems being addressed would have a use code of 'Reason for Visit'. Examples: * pregnancy would use HealthcareService or a coding as the reason * patient home monitoring could use Condition as the reason

    FHIR Encounter

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    use? value?

    Methods

    parse getUse setUse addUse hasUse getValue setValue addValue hasValue fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initUse initValue

    Constructors

    Properties

    use?: CodeableConcept[]

    Encounter.reason.use Element

    FHIR Specification

    • Short: What the reason value should be used for/as
    • Definition: What the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    value?: CodeableReference[]

    Encounter.reason.value Element

    FHIR Specification

    Methods

    • Parse the provided EncounterReasonComponent JSON to instantiate the EncounterReasonComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR EncounterReasonComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to EncounterReasonComponent

      Returns undefined | EncounterReasonComponent

      EncounterReasonComponent data model or undefined for EncounterReasonComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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

      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.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

      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.

      AssertionError for invalid url

    • 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

      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.

      AssertionError for invalid url

    • 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

    • 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

      AssertionError for invalid url

    • 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

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods