Data Model Libraries
    Preparing search index...

    Class DocumentReferenceContextComponent

    DocumentReferenceContextComponent Class

    FHIR Specification

    • Short: Clinical context of document
    • Definition: The clinical context in which the document was prepared.
    • Comment: These values are primarily added to help with searching for interesting/relevant documents.

    FHIR DocumentReference

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    encounter? event? period? facilityType? practiceSetting? sourcePatientInfo? related?

    Methods

    parse getEncounter setEncounter addEncounter hasEncounter getEvent setEvent addEvent hasEvent getPeriod setPeriod hasPeriod getFacilityType setFacilityType hasFacilityType getPracticeSetting setPracticeSetting hasPracticeSetting getSourcePatientInfo setSourcePatientInfo hasSourcePatientInfo getRelated setRelated addRelated hasRelated 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 initEncounter initEvent initRelated

    Constructors

    Properties

    encounter?: Reference[]

    DocumentReference.context.encounter Element

    FHIR Specification

    event?: CodeableConcept[]

    DocumentReference.context.event Element

    FHIR Specification

    • Short: Main clinical acts documented
    • Definition: This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
    • Comment: An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    period?: Period

    DocumentReference.context.period Element

    FHIR Specification

    • Short: Time of service that is being documented
    • Definition: The time period over which the service that is described by the document was provided.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    facilityType?: CodeableConcept

    DocumentReference.context.facilityType Element

    FHIR Specification

    • Short: Kind of facility where patient was seen
    • Definition: The kind of facility where the patient was seen.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    practiceSetting?: CodeableConcept

    DocumentReference.context.practiceSetting Element

    FHIR Specification

    • Short: Additional details about where the content was created (e.g. clinical specialty)
    • Definition: This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
    • Comment: This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.
    • Requirements: This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    sourcePatientInfo?: Reference

    DocumentReference.context.sourcePatientInfo Element

    FHIR Specification

    • Short: Patient demographics from source
    • Definition: The Patient Information as known when the document was published. May be a reference to a version specific, or contained.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    related?: Reference[]

    DocumentReference.context.related Element

    FHIR Specification

    • Short: Related identifiers or resources
    • Definition: Related identifiers or resources associated with the DocumentReference.
    • Comment: May be identifiers or resources that caused the DocumentReference or referenced Document to be created.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DocumentReferenceContextComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DocumentReferenceContextComponent

      DocumentReferenceContextComponent data model or undefined for DocumentReferenceContextComponent

      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