Data Model Libraries
    Preparing search index...

    Class DocumentReferenceContentProfileComponent

    DocumentReferenceContentProfileComponent Class

    FHIR Specification

    • Short: Content profile rules for the document
    • Definition: An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
    • Comment: Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI. For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    value: null | IDataType

    DocumentReference.content.profile.value[x] Element

    @ChoiceDataTypesMeta('DocumentReference.content.profile.value[x]', ['Coding','uri','canonical',]

    FHIR Specification

    • Short: Code|uri|canonical
    • Definition: Code|uri|canonical.
    • FHIR Types: 'Coding', 'uri', 'canonical',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DocumentReferenceContentProfileComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DocumentReferenceContentProfileComponent

      DocumentReferenceContentProfileComponent data model or undefined for DocumentReferenceContentProfileComponent

      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