Data Model Libraries
    Preparing search index...

    Class Requirements

    Requirements Class

    The Requirements resource is used to describe an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.

    FHIR Specification

    • Short: A set of requirements - features of systems that are necessary
    • Definition: A set of requirements - a list of features or behaviors of designed systems that are necessary to achieve organizational or regulatory goals.
    • FHIR Version: 5.0.0

    FHIR Requirements

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? versionAlgorithm? name? title? publicationStatusEnum status experimental? date? publisher? contact? description? useContext? jurisdiction? purpose? copyright? copyrightLabel? derivedFrom? reference? actor? statement?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getVersionAlgorithm setVersionAlgorithm hasVersionAlgorithm getVersionAlgorithmStringType hasVersionAlgorithmStringType getVersionAlgorithmCoding hasVersionAlgorithmCoding getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getCopyrightLabelElement setCopyrightLabelElement hasCopyrightLabelElement getCopyrightLabel setCopyrightLabel hasCopyrightLabel getDerivedFromElement setDerivedFromElement addDerivedFromElement hasDerivedFromElement getDerivedFrom setDerivedFrom addDerivedFrom hasDerivedFrom getReferenceElement setReferenceElement addReferenceElement hasReferenceElement getReference setReference addReference hasReference getActorElement setActorElement addActorElement hasActorElement getActor setActor addActor hasActor getStatement setStatement addStatement hasStatement 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 initContact initUseContext initJurisdiction initDerivedFrom initReference initActor initStatement

    Constructors

    Properties

    url?: UriType

    Requirements.url Element

    FHIR Specification

    • Short: Canonical identifier for this Requirements, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this Requirements when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Requirements is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Requirements is stored on different servers.
    • Comment: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • Requirements: Allows the Requirements to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    Requirements.identifier Element

    FHIR Specification

    • Short: Additional identifier for the Requirements (business identifier)
    • Definition: A formal identifier that is used to identify this Requirements when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    Requirements.version Element

    FHIR Specification

    • Short: Business version of the Requirements
    • Definition: The identifier that is used to identify this version of the Requirements when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Requirements author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Comment: There may be different Requirements instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the Requirements with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    versionAlgorithm?: IDataType

    Requirements.versionAlgorithm[x] Element

    @ChoiceDataTypesMeta('Requirements.versionAlgorithm[x]', ['string','Coding',]

    FHIR Specification

    • Short: How to compare versions
    • Definition: Indicates the mechanism used to compare versions to determine which is more current.
    • Comment: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
    • FHIR Types: 'string', 'Coding',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    Requirements.name Element

    FHIR Specification

    • Short: Name for this Requirements (computer friendly)
    • Definition: A natural language name identifying the Requirements. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    Requirements.title Element

    FHIR Specification

    • Short: Name for this Requirements (human friendly)
    • Definition: A short, descriptive, user-friendly title for the Requirements.
    • Comment: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    Requirements.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this Requirements. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of Requirements that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because designs and applications should not use a retired Requirements without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    Requirements.experimental Element

    FHIR Specification

    • Short: For testing purposes, not real usage
    • Definition: A Boolean value to indicate that this Requirements is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
    • Comment: Allows filtering of Requirements that are appropriate for use versus not.
    • Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level Requirements.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date?: DateTimeType

    Requirements.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the Requirements was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the Requirements changes.
    • Comment: Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Requirements. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    Requirements.publisher Element

    FHIR Specification

    • Short: Name of the publisher/steward (organization or individual)
    • Definition: The name of the organization or individual responsible for the release and ongoing maintenance of the Requirements.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the Requirements is the organization or individual primarily responsible for the maintenance and upkeep of the Requirements. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the Requirements. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the Requirements. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    Requirements.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: Contact details to assist a user in finding and communicating with the publisher.
    • Comment: May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    Requirements.description Element

    FHIR Specification

    • Short: Natural language description of the requirements
    • Definition: A free text natural language description of the requirements.
    • Comment: This description can be used for a general description of the requirements, and which covers why it was defined.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    useContext?: UsageContext[]

    Requirements.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Requirements instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    Requirements.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for Requirements (if applicable)
    • Definition: A legal or geographic region in which the Requirements is intended to be used.
    • Comment: It may be possible for the Requirements to be used in jurisdictions other than those for which it was originally designed or intended DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    Requirements.purpose Element

    FHIR Specification

    • Short: Why this Requirements is defined
    • Definition: Explanation of why this Requirements is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the Requirements. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Requirements.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    Requirements.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the Requirements and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Requirements.
    • Comment: ...
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the Requirements.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyrightLabel?: StringType

    Requirements.copyrightLabel Element

    FHIR Specification

    • Short: Copyright holder and year(s)
    • Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
    • Comment: The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
    • Requirements: Defines the content expected to be rendered in all representations of the artifact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    derivedFrom?: CanonicalType[]

    Requirements.derivedFrom Element

    FHIR Specification

    • Short: Other set of Requirements this builds on
    • Definition: Another set of Requirements that this set of Requirements builds on and updates.
    • Comment: Existing statements (by key) may be narrowed or clarified, and additional statements added.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    reference?: UrlType[]

    Requirements.reference Element

    FHIR Specification

    • Short: External artifact (rule/document etc. that) created this set of requirements
    • Definition: A reference to another artifact that created this set of requirements. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.
    • FHIR Type: url
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    actor?: CanonicalType[]

    Requirements.actor Element

    FHIR Specification

    • Short: Actor for these requirements
    • Definition: An actor these requirements are in regard to.
    • Comment: If more than one actor is specified, then it's up to the statements to describe in narrative if they don't apply to all actors.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    statement?: RequirementsStatementComponent[]

    Requirements.statement Element

    FHIR Specification

    • Short: Actual statement as markdown
    • Definition: The actual statement of requirement, in markdown format.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Requirements

      • OptionaloptSourceField: string

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

      Returns undefined | Requirements

      Requirements data model or undefined for Requirements

      JsonError if the provided JSON is not a valid JSON object

    • 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
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetVersionAlgorithmsetVersionAlgorithmhasVersionAlgorithmgetVersionAlgorithmStringTypehasVersionAlgorithmStringTypegetVersionAlgorithmCodinghasVersionAlgorithmCodinggetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetUseContextsetUseContextaddUseContexthasUseContextgetJurisdictionsetJurisdictionaddJurisdictionhasJurisdictiongetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetCopyrightLabelElementsetCopyrightLabelElementhasCopyrightLabelElementgetCopyrightLabelsetCopyrightLabelhasCopyrightLabelgetDerivedFromElementsetDerivedFromElementaddDerivedFromElementhasDerivedFromElementgetDerivedFromsetDerivedFromaddDerivedFromhasDerivedFromgetReferenceElementsetReferenceElementaddReferenceElementhasReferenceElementgetReferencesetReferenceaddReferencehasReferencegetActorElementsetActorElementaddActorElementhasActorElementgetActorsetActoraddActorhasActorgetStatementsetStatementaddStatementhasStatementfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitContactinitUseContextinitJurisdictioninitDerivedFrominitReferenceinitActorinitStatement