Data Model Libraries
    Preparing search index...

    Class FamilyMemberHistoryProcedureComponent

    FamilyMemberHistoryProcedureComponent Class

    FHIR Specification

    • Short: Procedures that the related person had
    • Definition: The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeableConcept

    FamilyMemberHistory.procedure.code Element

    FHIR Specification

    • Short: Procedures performed on the related person
    • Definition: The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating system.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    outcome?: CodeableConcept

    FamilyMemberHistory.procedure.outcome Element

    FHIR Specification

    • Short: What happened following the procedure
    • Definition: Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    contributedToDeath?: BooleanType

    FamilyMemberHistory.procedure.contributedToDeath Element

    FHIR Specification

    • Short: Whether the procedure contributed to the cause of death
    • Definition: This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    performed?: IDataType

    FamilyMemberHistory.procedure.performed[x] Element

    @ChoiceDataTypesMeta('FamilyMemberHistory.procedure.performed[x]', ['Age','Range','Period','string','dateTime',]

    FHIR Specification

    • Short: When the procedure was performed
    • Definition: Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
    • FHIR Types: 'Age', 'Range', 'Period', 'string', 'dateTime',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    FamilyMemberHistory.procedure.note Element

    FHIR Specification

    • Short: Extra information about the procedure
    • Definition: An area where general notes can be placed about this specific procedure.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR FamilyMemberHistoryProcedureComponent

      • OptionaloptSourceField: string

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

      Returns undefined | FamilyMemberHistoryProcedureComponent

      FamilyMemberHistoryProcedureComponent data model or undefined for FamilyMemberHistoryProcedureComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise