Data Model Libraries
    Preparing search index...

    Class List

    List Class

    A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.

    FHIR Specification

    • Short: A list is a curated collection of resources
    • Definition: A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.
    • FHIR Version: 5.0.0

    FHIR List

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? listStatusEnum status listModeEnum mode title? code? subject? encounter? date? source? orderedBy? note? entry? emptyReason?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getModeEnumType setModeEnumType hasModeEnumType getModeElement setModeElement hasModeElement getMode setMode hasMode getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getCode setCode hasCode getSubject setSubject addSubject hasSubject getEncounter setEncounter hasEncounter getDateElement setDateElement hasDateElement getDate setDate hasDate getSource setSource hasSource getOrderedBy setOrderedBy hasOrderedBy getNote setNote addNote hasNote getEntry setEntry addEntry hasEntry getEmptyReason setEmptyReason hasEmptyReason fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initSubject initNote initEntry

    Constructors

    Properties

    identifier?: Identifier[]

    List.identifier Element

    FHIR Specification

    • Short: Business identifier
    • Definition: Identifier for the List assigned for business purposes outside the context of FHIR.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    listStatusEnum: ListStatusEnum

    FHIR CodeSystem: ListStatus

    ListStatusEnum

    status: null | EnumCodeType

    List.status Element

    FHIR Specification

    • Short: current | retired | entered-in-error
    • Definition: Indicates the current state of this list.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: ListStatusEnum

    listModeEnum: ListModeEnum

    FHIR CodeSystem: ListMode

    ListModeEnum

    mode: null | EnumCodeType

    List.mode Element

    FHIR Specification

    • Short: working | snapshot | changes
    • Definition: How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
    • Comment: This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
    • Requirements: Lists are used in various ways, and it must be known in what way it is safe to use them.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: If set to "changes", the list is considered incomplete, while the other two codes indicate the list is complete, which changes the understanding of the elements listed
    • isSummary: true

    CodeSystem Enumeration: ListModeEnum

    title?: StringType

    List.title Element

    FHIR Specification

    • Short: Descriptive name for the list
    • Definition: A label for the list assigned by the author.
    • Requirements: Allows customization beyond just the code identifying the kind of list.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    code?: CodeableConcept

    List.code Element

    FHIR Specification

    • Short: What the purpose of this list is
    • Definition: This code defines the purpose of the list - why it was created.
    • Comment: If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.
    • Requirements: Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject?: Reference[]

    List.subject Element

    FHIR Specification

    • Short: If all resources have the same subject(s)
    • Definition: The common subject(s) (or patient(s)) of the resources that are in the list if there is one (or a set of subjects).
    • Comment: Some purely arbitrary lists do not have a common subject, so this is optional. Lists having multiple subjects may raise challenges for systems that base access control or other security considerations on linkages to 'subject'. E.g. if a List is associated with multiple Patient subjects, then it would be nominally part of multiple patient compartments, which might drive access rights.
    • Requirements: The primary purpose of listing the subject explicitly is to help with finding the right list.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    encounter?: Reference

    List.encounter Element

    FHIR Specification

    • Short: Context in which list created
    • Definition: The encounter that is the context in which this list was created.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    date?: DateTimeType

    List.date Element

    FHIR Specification

    • Short: When the list was prepared
    • Definition: Date list was last reviewed/revised and determined to be 'current'.
    • Comment: The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.
    • Requirements: Identifies how current the list is which affects relevance.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    source?: Reference

    List.source Element

    FHIR Specification

    orderedBy?: CodeableConcept

    List.orderedBy Element

    FHIR Specification

    • Short: What order the list has
    • Definition: What order applies to the items in the list.
    • Comment: Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
    • Requirements: Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    List.note Element

    FHIR Specification

    • Short: Comments about the list
    • Definition: Comments that apply to the overall list.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Private Optionalentry

    entry?: ListEntryComponent[]

    List.entry Element

    FHIR Specification

    • Short: Entries in the list
    • Definition: Entries in this list.
    • Comment: If there are no entries in the list, an emptyReason SHOULD be provided.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    emptyReason?: CodeableConcept

    List.emptyReason Element

    FHIR Specification

    • Short: Why list is empty
    • Definition: If the list is empty, why the list is empty.
    • Comment: The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.
    • Requirements: Allows capturing things like "none exist" or "not asked" which can be important for most lists.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR List

      • OptionaloptSourceField: string

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

      Returns undefined | List

      List data model or undefined for List

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Source object value to the source property.

      Parameters

      • value: undefined | Reference

        the source object value

      Returns this

      this

      @ReferenceTargets('List.source', ['Practitioner','PractitionerRole','Patient','Device','Organization','RelatedPerson','CareTeam',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetModeEnumTypesetModeEnumTypehasModeEnumTypegetModeElementsetModeElementhasModeElementgetModesetModehasModegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetCodesetCodehasCodegetSubjectsetSubjectaddSubjecthasSubjectgetEncountersetEncounterhasEncountergetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetSourcesetSourcehasSourcegetOrderedBysetOrderedByhasOrderedBygetNotesetNoteaddNotehasNotegetEntrysetEntryaddEntryhasEntrygetEmptyReasonsetEmptyReasonhasEmptyReasonfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitSubjectinitNoteinitEntry