DiGA-API

Element id

DeviceDefinition

Short description

Digitale Anwendung

Definition

In diesem Profil werden Informationen zu einer digitalen Gesundheitsanwendung (DiGA) bzw. digitalen Pflegeanwendung (DiPA) repräsentiert.

Comments

For the initial scope, this DeviceDefinition resource is only applicable to describe a single node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard and that does not represent a metric. Examples for such a node are MDS, VMD, or Channel.

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Mappings

rim: N/A

extension

0..*

Element id

DeviceDefinition.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension(AttachmentHealthApp)

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

handbook

S C

0..1

Element id

DeviceDefinition.extension:handbook

Short description

Handbuch

Alternate names

extensions, user content

Definition

Das Handbuch der digitalen Anwendung.

Comments

Data type

Extension(AttachmentHealthApp)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppHandbook

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

media

S C

0..1

Extension(Complex)

Element id

DeviceDefinition.extension:media

Short description

Mediendaten

Alternate names

extensions, user content

Definition

Die Mediendaten der digitalen Anwendung.

Comments

Data type

Extension(Complex)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppMedia

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

nutzungshinweis

S C

0..1

Extension(Complex)

Element id

DeviceDefinition.extension:nutzungshinweis

Short description

Nutzungshinweise

Alternate names

extensions, user content

Definition

Nur DiGA: Enthält Hinweise, die bei der Nutzung der digitalen Anwendung berücksichtigt werden sollen.

Comments

Data type

Extension(Complex)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppNutzungshinweis

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

summaries

S C

0..1

Extension(Complex)

Element id

DeviceDefinition.extension:summaries

Short description

Redaktionelle Beschreibungen

Alternate names

extensions, user content

Definition

Enthält redaktionelle Beschreibungen der digitalen Anwendung.

Comments

Data type

Extension(Complex)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppSummaries

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

identifier

1..*

Element id

DeviceDefinition.identifier

Short description

IDs der digitalen Anwendung

Definition

Enthält Werte zur eindeutigen Identifizierung der digitalen Anwendung.

Data type

Slicing

Unordered, Open, by system(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier

digaId

0..1

Element id

DeviceDefinition.identifier:digaId

Short description

DiGA-ID im Verzeichnis

Definition

Die eindeutige Verzeichnisnummer der digitalen Gesundheitsanwendung (DiGA-ID) im Verzeichnis nach § 139e SGB V.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:digaId.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:digaId.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:digaId.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:digaId.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

uriFixed Value

Element id

DeviceDefinition.identifier:digaId.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

https://fhir.bfarm.de/Identifier/DigaId

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:digaId.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:digaId.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:digaId.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

dipaId

0..1

Element id

DeviceDefinition.identifier:dipaId

Short description

DiPA-ID im Verzeichnis

Definition

Die eindeutige Verzeichnisnummer der digitalen Pflegeanwendung (DiPA-ID) im Verzeichnis nach § 78a SGB XI.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:dipaId.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:dipaId.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:dipaId.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:dipaId.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

uriFixed Value

Element id

DeviceDefinition.identifier:dipaId.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

https://fhir.bfarm.de/Identifier/DipaId

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:dipaId.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:dipaId.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:dipaId.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

healthAppId

1..1

Element id

DeviceDefinition.identifier:healthAppId

Short description

HealthApp-ID

Definition

Die eindeutige interne Identifikationsnummer einer HealthApp.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:healthAppId.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:healthAppId.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:healthAppId.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:healthAppId.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

uriFixed Value

Element id

DeviceDefinition.identifier:healthAppId.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

https://fhir.bfarm.de/Identifier/HealthAppId

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:healthAppId.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:healthAppId.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.identifier:healthAppId.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

udiDeviceIdentifier

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.udiDeviceIdentifier

Short description

Unique Device Identifier (UDI) Barcode string

Definition

Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.udiDeviceIdentifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.udiDeviceIdentifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.udiDeviceIdentifier.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

deviceIdentifier

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.udiDeviceIdentifier.deviceIdentifier

Short description

The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier

Definition

The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

issuer

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.udiDeviceIdentifier.issuer

Short description

The organization that assigns the identifier algorithm

Definition

The organization that assigns the identifier algorithm.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

jurisdiction

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.udiDeviceIdentifier.jurisdiction

Short description

The jurisdiction to which the deviceIdentifier applies

Definition

The jurisdiction to which the deviceIdentifier applies.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

manufacturer[x]

0..1

Element id

DeviceDefinition.manufacturer[x]

Short description

HealthAppManufacturer

Definition

Die Referenz auf den Hersteller der digitalen Anwendung (HealthAppManufacturer).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .playedRole[typeCode=MANU].scoper.name

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.manufacturer[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.manufacturer[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

reference

S Σ C

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.manufacturer[x].reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.manufacturer[x].type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.manufacturer[x].identifier

Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .identifier

display

S Σ

0..1

Element id

DeviceDefinition.manufacturer[x].display

Short description

Klarname des Herstellers

Definition

Der Klarname des Herstellers (Organisation oder Privatperson), der die digitale Anwendung bereitstellt.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Reference(HealthAppManufacturer)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

manufacturerReference

Data type

Reference(HealthAppManufacturer)

deviceName

0..*

Element id

DeviceDefinition.deviceName

Short description

Anwendungsname

Definition

Die namentliche Bezeichnung der digitalen Anwendung.

Data type

Slicing

Unordered, Open, by type(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.deviceName.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.deviceName.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.deviceName.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

name

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.deviceName.name

Short description

The name of the device

Alternate names

Definition

The name of the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

type

1..1

codeBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.deviceName.type

Short description

Definition

The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

Data type

Binding

The type of name the device is referred by.

DeviceNameType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .playedRole[typeCode=MANU].code

user-friendly-name

0..1

Element id

DeviceDefinition.deviceName:user-friendly-name

Short description

Name

Definition

Der Name der digitalen Anwendung.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.deviceName:user-friendly-name.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.deviceName:user-friendly-name.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.deviceName:user-friendly-name.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

name

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.deviceName:user-friendly-name.name

Short description

The name of the device

Alternate names

Definition

The name of the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

type

1..1

codeBindingFixed Value

Element id

DeviceDefinition.deviceName:user-friendly-name.type

Short description

Definition

The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

Data type

Binding

The type of name the device is referred by.

DeviceNameType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

user-friendly-name

Mappings

w5: FiveWs.what[x]
rim: .playedRole[typeCode=MANU].code

modelNumber

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.modelNumber

Short description

The model number for the device

Definition

The model number for the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]
rim: .softwareName (included as part)

type

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.type

Short description

What kind of device or device system this is

Definition

What kind of device or device system this is.

Data type

Binding

Type of device e.g. according to official classification.

FHIRDeviceTypes (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

specialization

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.specialization

Short description

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication

Definition

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.specialization.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.specialization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.specialization.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

systemType

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.specialization.systemType

Short description

The standard that is used to operate and communicate

Alternate names

Definition

The standard that is used to operate and communicate.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

version

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.specialization.version

Short description

The version of the standard that is used to operate and communicate

Definition

The version of the standard that is used to operate and communicate.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.what[x]

version

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.version

Short description

Available versions

Definition

The available versions of the device, e.g., software versions.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

safety

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.safety

Short description

Safety characteristics of the device

Definition

Safety characteristics of the device.

Data type

Binding

DeviceSafety (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

shelfLifeStorage

0..*

ProductShelfLife

There are no (further) constraints on this element

Element id

DeviceDefinition.shelfLifeStorage

Short description

Shelf Life and storage information

Definition

Shelf Life and storage information.

Data type

ProductShelfLife

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

physicalCharacteristics

0..1

ProdCharacteristic

There are no (further) constraints on this element

Element id

DeviceDefinition.physicalCharacteristics

Short description

Dimensions, color etc.

Definition

Dimensions, color etc.

Data type

ProdCharacteristic

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

languageCode

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.languageCode

Short description

Language code for the human-readable text strings produced by the device (all supported)

Definition

Language code for the human-readable text strings produced by the device (all supported).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

capability

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.capability

Short description

Device capabilities

Definition

Device capabilities.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.capability.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.capability.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.capability.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

type

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.capability.type

Short description

Type of capability

Definition

Type of capability.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

description

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.capability.description

Short description

Description of capability

Definition

Description of capability.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

property

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.property

Short description

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties

Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.property.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.property.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.property.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

type

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.property.type

Short description

Code that specifies the property DeviceDefinitionPropetyCode (Extensible)

Definition

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueQuantity

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.property.valueQuantity

Short description

Property value as a quantity

Definition

Property value as a quantity.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCode

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.property.valueCode

Short description

Property value as a code, e.g., NTP4 (synced to NTP)

Definition

Property value as a code, e.g., NTP4 (synced to NTP).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

owner

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.owner

Short description

Organization responsible for device

Definition

An organization that is responsible for the provision and ongoing maintenance of the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.source
rim: .playedRole[typeCode=OWN].scoper

contact

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.contact

Short description

Details for human/organization for support

Definition

Contact details for an organization or a particular human that is responsible for the device.

Comments

used for troubleshooting etc.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.source
rim: .scopedRole[typeCode=CON].player

url

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.url

Short description

Network address to contact device

Definition

A network address on which the device may be contacted directly.

Comments

If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.where[x]
rim: .telecom

onlineInformation

0..1

Element id

DeviceDefinition.onlineInformation

Short description

Informationswebsite

Definition

Die URL zur Informationswebsite der digitalen Anwendung.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

note

0..*

Annotation

There are no (further) constraints on this element

Element id

DeviceDefinition.note

Short description

Device notes and comments

Definition

Descriptive information, usage information or implantation information that is not captured in an existing element.

Data type

Annotation

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .text

quantity

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.quantity

Short description

The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)

Definition

The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).

Data type

Reference(DeviceDefinition)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

parentDevice

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.parentDevice

Short description

The parent device it can be part of

Definition

The parent device it can be part of.

Data type

Reference(DeviceDefinition)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

material

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.material

Short description

A substance used to create the material(s) of which the device is made

Definition

A substance used to create the material(s) of which the device is made.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.material.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.material.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.material.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

substance

1..1

There are no (further) constraints on this element

Element id

DeviceDefinition.material.substance

Short description

The substance

Definition

The substance.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

alternate

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.material.alternate

Short description

Indicates an alternative material of the device

Definition

Indicates an alternative material of the device.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

allergenicIndicator

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.material.allergenicIndicator

Short description

Whether the substance is a known or suspected allergen

Definition

Whether the substance is a known or suspected allergen.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

HealthAppCatalogEntry

Das Profil HealthAppCatalogEntry (CatalogEntry) repräsentiert die einzelnen Einträge des DiGA-Verzeichnisses. Jeder Eintrag referenziert auf genau eine DiGA (HealthApp).

HealthAppCatalogEntry (CatalogEntry)

S C

CatalogEntry

Element id

CatalogEntry

Short description

Eintrag einer digitalen Anwendung in einem Verzeichnis

Definition

Das Profil repräsentiert den Eintrag einer digitalen Gesundheitsanwendung (DiGA) bzw. digitalen Pflegeanwendung (DiPA) in einem Verzeichnis.

Data type

CatalogEntry

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

CatalogEntry.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

Element id

CatalogEntry.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHistory

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

history

S C

0..1

Extension(Complex)

Element id

CatalogEntry.extension:history

Short description

Änderunghistorie

Alternate names

extensions, user content

Definition

Enthält alle öffentlichen Einträge der Änderungshistorie.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

trialPeriod

S C

0..1

Extension(Complex)

Element id

CatalogEntry.extension:trialPeriod

Short description

Erprobungszeitraum

Alternate names

extensions, user content

Definition

Nur DiGA: Angaben zum Erprobungszeitraum.

Comments

Data type

Extension(Complex)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryTrialPeriod

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

identifier

S Σ

0..*

Element id

CatalogEntry.identifier

Short description

IDs des Verzeichniseintrags

Definition

Enthält Werte zur eindeutigen Identifizierung des Verzeichniseintrags der digitalen Anwendung.

Data type

Slicing

Unordered, Open, by system(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

S Σ

0..1

Element id

CatalogEntry.identifier:url

Short description

URL des Verzeichniseintrags

Definition

Enthält die URL zum Verzeichniseintrag der digitalen Anwendung.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.identifier:url.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.identifier:url.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

CatalogEntry.identifier:url.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CatalogEntry.identifier:url.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

uriFixed Value

Element id

CatalogEntry.identifier:url.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

urn:ietf:rfc:3986

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

CatalogEntry.identifier:url.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.identifier:url.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.identifier:url.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

type

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.type

Short description

The type of item - medication, device, service, protocol or other

Definition

The type of item - medication, device, service, protocol or other.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

orderable

S Σ

1..1

Element id

CatalogEntry.orderable

Short description

Bestellfähigkeit

Definition

Gibt an, ob die mit dem Verzeichniseintrag verknüpfte digitale Anwendung bestell- oder verordnungsfähig ist.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

referencedItem

S Σ

1..1

Element id

CatalogEntry.referencedItem

Short description

HealthApp

Definition

Die Referenz zur digitalen Anwendung (HealthApp).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.referencedItem.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

1..*

There are no (further) constraints on this element

Element id

CatalogEntry.referencedItem.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppCatalogEntryHealthAppLink

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

deviceDefinition

S C

1..1

Extension(Reference(HealthApp))

Element id

CatalogEntry.referencedItem.extension:deviceDefinition

Short description

Verweis

Alternate names

extensions, user content

Definition

Der Verweis auf die digitale Anwendung (HealthApp).

Comments

Data type

Extension(Reference(HealthApp))

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.referencedItem.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

CatalogEntry.referencedItem.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.referencedItem.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.referencedItem.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

additionalIdentifier

0..*

Element id

CatalogEntry.additionalIdentifier

Short description

IDs im anderen Verzeichnis

Definition

Enthält Werte zur eindeutigen Identifizierung des Verzeichniseintrags im jeweils anderen Verzeichnis wenn die digitale Anwendung sowohl digitale Gesundheitsanwendung (DiGA) als auch digitale Pflegeanwendung (DiPA) ist.

Data type

Slicing

Unordered, Open, by system(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

0..1

Element id

CatalogEntry.additionalIdentifier:url

Short description

URL des Verzeichniseintrags

Definition

Enthält die URL zum Verzeichniseintrag der digitalen Anwendung.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.additionalIdentifier:url.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.additionalIdentifier:url.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

CatalogEntry.additionalIdentifier:url.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CatalogEntry.additionalIdentifier:url.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

uriFixed Value

Element id

CatalogEntry.additionalIdentifier:url.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

urn:ietf:rfc:3986

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

CatalogEntry.additionalIdentifier:url.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.additionalIdentifier:url.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.additionalIdentifier:url.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

classification

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.classification

Short description

Classification (category or class) of the item entry

Definition

Classes of devices, or ATC for medication.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

status

1..1

codeBinding

Element id

CatalogEntry.status

Short description

Status der Listung (draft | active | retired)

Definition

Repräsentiert den Status des Eintrags der digitalen Anwendung im Verzeichnis.

draft: vorläufig aufgenommen (nur DiGA)
active: dauerhaft aufgenommen
retired: zurückgezogen/entfernt/gestrichen

Data type

Binding

The lifecycle status of an artifact.

PublicationStatus (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

validityPeriod

0..1

Element id

CatalogEntry.validityPeriod

Short description

Gültigkeitszeitraum

Definition

Der Zeitraum, in dem der Verzeichniseintrag der digitalen Anwendung gültig ist oder war; kann ein Startdatum (z.B. Aufnahme in das Verzeichnis) und ein Enddatum (z.B. Streichung aus dem Verzeichnis) enthalten.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.validityPeriod.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.validityPeriod.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

start

S Σ C

0..1

Element id

CatalogEntry.validityPeriod.start

Short description

Erster Gültigkeitstag

Definition

Das Datum der erstmaligen Aufnahme der digitalen Anwendung in das Verzeichnis.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: DR.1
rim: ./low

end

S Σ C

0..1

Element id

CatalogEntry.validityPeriod.end

Short description

Letzter Gültigkeitstag

Definition

Der letzte Gültigkeitstag der digitalen Anwendung im Verzeichnis.

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: DR.2
rim: ./high

validTo

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.validTo

Short description

The date until which this catalog entry is expected to be active

Definition

The date until which this catalog entry is expected to be active.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastUpdated

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.lastUpdated

Short description

When was this catalog last updated

Definition

Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.

Comments

Perhaps not needed - if we use fhir resource metadata.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

additionalCharacteristic

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.additionalCharacteristic

Short description

Additional characteristics of the catalog entry

Definition

Used for examplefor Out of Formulary, or any specifics.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

additionalClassification

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.additionalClassification

Short description

Additional classification of the catalog entry

Definition

User for example for ATC classification, or.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.relatedEntry

Short description

An item that this catalog entry is related to

Definition

Used for example, to point to a substance, or to a device used to administer a medication.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

CatalogEntry.relatedEntry.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.relatedEntry.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

CatalogEntry.relatedEntry.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

relationtype

1..1

codeBinding

There are no (further) constraints on this element

Element id

CatalogEntry.relatedEntry.relationtype

Short description

triggers | is-replaced-by

Definition

The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.

Data type

CatalogEntryRelationType (required)

Binding

The type of relations between entries.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

item

1..1

Reference(CatalogEntry)

There are no (further) constraints on this element

Element id

CatalogEntry.relatedEntry.item

Short description

The reference to the related item

Definition

The reference to the related item.

Data type

Reference(CatalogEntry)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

HealthAppManufacturer

Das Profil HealthAppManufacturer (Organization) repräsentiert den Hersteller einer DiGA und ist mit dem Profil HealthApp verknüpft.

HealthAppManufacturer (Organization)

S C

Organization

Element id

Organization

Short description

Hersteller einer digitalen Anwendung

Definition

In diesem Profil werden Informationen zu einem Hersteller einer digitalen Gesundheitsanwendung (DiGA) bzw. digitalen Pflegeanwendung (DiGA) repräsentiert.

Data type

Organization

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
(identifier.count() + name.count()) > 0

Mappings

rim: Entity. Role, or Act
v2: (also see master files messages)
rim: Organization(classCode=ORG, determinerCode=INST)
servd: Organization

0..1

There are no (further) constraints on this element

Element id

Organization.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Organization.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Organization.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

Organization.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

Organization.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

Organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Organization.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

identifier

S Σ C

0..*

Element id

Organization.identifier

Short description

Identifikationsmerkmale

Definition

Enthält Merkmale zur eindeutigen Identifikation des Herstellers der digitalen Anwendung.

Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Data type

Slicing

Unordered, Open, by system(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: org-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier
v2: XON.10 / XON.3
rim: .scopes[Role](classCode=IDENT)
servd: ./Identifiers

iknr

S Σ C

0..1

IdentifierIknr

Element id

Organization.identifier:iknr

Short description

Institutionskennzeichen

Definition

Das Institutionskennzeichen (IK) ist ein eindeutiges Merkmal zur Abrechnung mit den Trägern der Sozialversicherung und dient hier zur Identifikation des Herstellers der digitalen Anwendung.

Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Data type

IdentifierIknr

Conditions

The cardinality or value of this element may be affected by these constraints: org-1, ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.identifier
v2: XON.10 / XON.3
rim: .scopes[Role](classCode=IDENT)
servd: ./Identifiers
rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier

0..1

There are no (further) constraints on this element

Element id

Organization.identifier:iknr.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.identifier:iknr.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.identifier:iknr.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBindingPattern

There are no (further) constraints on this element

Element id

Organization.identifier:iknr.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

IdentifierTypeDeBasis (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code": "XX"
    }
  ]
}

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Organization.identifier:iknr.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/sid/arge-ik/iknr

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ C

1..1

There are no (further) constraints on this element

Element id

Organization.identifier:iknr.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ik-1: Eine IK muss 8- (ohne Prüfziffer) oder 9-stellig (mit Prüfziffer) sein
matches('[0-9]{8,9}')

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Organization.identifier:iknr.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Organization.identifier:iknr.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

active

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Organization.active

Short description

Whether the organization's record is still in active use

Definition

Whether the organization's record is still in active use.

Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.status
v2: No equivalent in HL7 v2
rim: .status
servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.

type

S Σ

0..*

Element id

Organization.type

Short description

Herstellertyp

Definition

Gibt an ob es sich um eine juristische oder um eine natürliche Person handelt.

Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Data type

Slicing

Unordered, Open, by coding.system(Value)

Binding

Used to categorize the organization.

OrganizationType (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.class
v2: No equivalent in v2
rim: .code
servd: n/a

personenTyp

S Σ

0..1

There are no (further) constraints on this element

Element id

Organization.type:personenTyp

Short description

Kind of organization

Definition

The kind(s) of organization that this is.

Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Data type

Binding

Used to categorize the organization.

OrganizationType (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.class
v2: No equivalent in v2
rim: .code
servd: n/a

0..1

There are no (further) constraints on this element

Element id

Organization.type:personenTyp.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.type:personenTyp.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

CodingHealthAppManufacturerType

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

coding

S Σ

0..1

Element id

Organization.type:personenTyp.coding

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingHealthAppManufacturerType

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

text

0..1

There are no (further) constraints on this element

Element id

Organization.type:personenTyp.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

name

S Σ C

0..1

Element id

Organization.name

Short description

Herstellername

Definition

Der Klarname des Herstellers (Organisation oder Privatperson), der die digitale Anwendung bereitstellt.

Requirements

Need to use the name as the label of the organization.

Comments

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: org-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XON.1
rim: .name
servd: .PreferredName/Name

alias

0..*

There are no (further) constraints on this element

Element id

Organization.alias

Short description

A list of alternate names that the organization is known as, or was known as in the past

Definition

A list of alternate names that the organization is known as, or was known as in the past.

Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .name

telecom

S C

0..*

Element id

Organization.telecom

Short description

Kontaktdaten

Definition

Die Kontaktinformationen der Herstellers der digitalen Anwendung.

Requirements

Human contact for the organization.

Comments

The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Data type

Slicing

Unordered, Open, by system(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: org-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

v2: ORC-22?
rim: .telecom
servd: ./ContactPoints

S C

0..1

Element id

Organization.telecom:email

Short description

E-Mail-Adresse

Definition

Die E-Mail-Adresse des Herstellers.

Requirements

Human contact for the organization.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: org-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

v2: ORC-22?
rim: .telecom
servd: ./ContactPoints

0..1

There are no (further) constraints on this element

Element id

Organization.telecom:email.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.telecom:email.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ C

1..1

codeBindingFixed Value

Element id

Organization.telecom:email.system

Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Data type

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: cpt-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

email

Mappings

v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

Organization.telecom:email.value

Short description

The actual contact point details

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.telecom:email.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

Binding

Use of contact point.

ContactPointUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..1

There are no (further) constraints on this element

Element id

Organization.telecom:email.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: n/a
rim: n/a

period

0..1

There are no (further) constraints on this element

Element id

Organization.telecom:email.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

address

S C

0..1

Element id

Organization.address

Short description

Anschrift des Herstellers

Definition

Enthält die postalische Anschrift des Herstellers der digitalen Anwendung.

Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Comments

Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: org-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
org-2: An address of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

v2: ORC-23?
rim: .address
servd: ./PrimaryAddress and ./OtherAddresses

0..1

There are no (further) constraints on this element

Element id

Organization.address.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.address.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.address.use

Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

Binding

The use of an address.

AddressUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

home

Mappings

v2: XAD.7
rim: unique(./use)
servd: ./AddressPurpose

type

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.address.type

Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Data type

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

both

Mappings

v2: XAD.18
rim: unique(./use)
vcard: address type parameter

text

0..1

There are no (further) constraints on this element

Element id

Organization.address.text

Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

137 Nowhere Street, Erewhon 9132

Mappings

v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
rim: ./formatted
vcard: address label parameter

line

S Σ

0..*

Element id

Organization.address.line

Short description

Adressinformationen des Herstellers

Definition

Diese Komponente enthält Hausnummer, Wohnungsnummer, Straßenname, Straßenrichtung, Postfachnummer, Zustellhinweise und ähnliche Adressinformationen der Herstelleranschrift der digitalen Gesundheitsanwendung (DiGA) oder digitalen Pflegeanwendung (DiPA).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

137 Nowhere Street

Mappings

v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
rim: AD.part[parttype = AL]
vcard: street
servd: ./StreetAddress (newline delimitted)

city

S Σ

0..1

Element id

Organization.address.city

Short description

Adressinformationen (Ort)

Alternate names

Municpality

Definition

Diese Komponente enthält den Namen der Stadt, des Ortes, des Vorortes, des Dorfes oder einer Gemeinde, die zur Anschrift des Herstellers der digitalen Anwendung gehört.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Erewhon

Mappings

v2: XAD.3
rim: AD.part[parttype = CTY]
vcard: locality
servd: ./Jurisdiction

district

0..1

There are no (further) constraints on this element

Element id

Organization.address.district

Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Madison

Mappings

v2: XAD.9
rim: AD.part[parttype = CNT | CPA]

state

0..1

There are no (further) constraints on this element

Element id

Organization.address.state

Short description

Sub-unit of country (abbreviations ok)

Alternate names

Province, Territory

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XAD.4
rim: AD.part[parttype = STA]
vcard: region
servd: ./Region

postalCode

S Σ

0..1

Element id

Organization.address.postalCode

Short description

Adressinformation (PLZ)

Alternate names

Zip

Definition

Diese Komponente enthält die Postleitzahl, die zur Anschrift des Herstellers der digitalen Anwendung gehört.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: XAD.5
rim: AD.part[parttype = ZIP]
vcard: code
servd: ./PostalIdentificationCode

country

S Σ

0..1

Element id

Organization.address.country

Short description

Adressinformation (Land)

Definition

Diese Komponente enthält die Information wo, in welchem Land, der Hersteller der digitalen Anwendung ansässig ist. Dies kann z. B. durch einen ISO-3166-Code mit 2 oder 3 Buchstaben abgebildet werden.

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XAD.6
rim: AD.part[parttype = CNT]
vcard: country
servd: ./Country

period

0..1

There are no (further) constraints on this element

Element id

Organization.address.period

Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}

Mappings

v2: XAD.12 / XAD.13 + XAD.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

partOf

0..1

There are no (further) constraints on this element

Element id

Organization.partOf

Short description

The organization of which this organization forms a part

Definition

The organization of which this organization forms a part.

Requirements

Need to be able to track the hierarchy of organizations within an organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: No equivalent in HL7 v2
rim: .playedBy[classCode=Part].scoper
servd: n/a

contact

0..1

Element id

Organization.contact

Short description

Ansprechpartner

Definition

Enthält Kontaktinformationen des Ansprechpartners des Herstellers.

Requirements

Need to keep track of assigned contact points within bigger organization.

Comments

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .contactParty

0..1

There are no (further) constraints on this element

Element id

Organization.contact.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.contact.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Organization.contact.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

purpose

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Organization.contact.purpose

Short description

The type of contact

Definition

Indicates a purpose for which the contact can be reached.

Requirements

Need to distinguish between multiple contact persons.

Data type

ContactEntityType (extensible)

Binding

The purpose for which you would contact a contact party.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: ./type

name

0..1

HumanName

Element id

Organization.contact.name

Short description

Name

Definition

Der Name des Ansprechpartners.

Requirements

Need to be able to track the person by name.

Data type

HumanName

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: PID-5, PID-9
rim: ./name

0..1

There are no (further) constraints on this element

Element id

Organization.contact.name.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.contact.name.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.contact.name.use

Short description

Definition

Identifies the purpose for this name.

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Data type

Binding

The use of a human name.

NameUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XPN.7, but often indicated by which field contains the name
rim: unique(./use)
servd: ./NamePurpose

text

0..1

There are no (further) constraints on this element

Element id

Organization.contact.name.text

Short description

Text representation of the full name

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: implied by XPN.11
rim: ./formatted

family

S Σ

0..1

Element id

Organization.contact.name.family

Short description

Nachname

Alternate names

surname

Definition

Der Nachname des Ansprechpartners.

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XPN.1/FN.1
rim: ./part[partType = FAM]
servd: ./FamilyName

given

S Σ

0..*

Element id

Organization.contact.name.given

Short description

Vorname

Alternate names

first name, middle name

Definition

Der Vorname des Ansprechpartners.

Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XPN.2 + XPN.3
rim: ./part[partType = GIV]
servd: ./GivenNames

prefix

0..*

There are no (further) constraints on this element

Element id

Organization.contact.name.prefix

Short description

Parts that come before the name

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XPN.5
rim: ./part[partType = PFX]
servd: ./TitleCode

suffix

0..*

There are no (further) constraints on this element

Element id

Organization.contact.name.suffix

Short description

Parts that come after the name

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XPN/4
rim: ./part[partType = SFX]

period

0..1

There are no (further) constraints on this element

Element id

Organization.contact.name.period

Short description

Time period when name was/is in use

Definition

Indicates the period of time when this name was valid for the named person.

Requirements

Allows names to be placed in historical context.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XPN.13 + XPN.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

telecom

0..*

Element id

Organization.contact.telecom

Short description

Kontaktdaten

Definition

Kontaktinformationen eines Ansprechpartners

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Data type

Slicing

Unordered, Open, by system(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: PID-13, PID-14
rim: ./telecom

0..1

Element id

Organization.contact.telecom:email

Short description

E-Mail-Adresse

Definition

Die E-Mail-Adresse des Ansprechpartners.

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: PID-13, PID-14
rim: ./telecom

0..1

There are no (further) constraints on this element

Element id

Organization.contact.telecom:email.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.contact.telecom:email.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ C

1..1

codeBindingFixed Value

Element id

Organization.contact.telecom:email.system

Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Data type

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: cpt-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

email

Mappings

v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

Organization.contact.telecom:email.value

Short description

The actual contact point details

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.contact.telecom:email.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

Binding

Use of contact point.

ContactPointUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..1

There are no (further) constraints on this element

Element id

Organization.contact.telecom:email.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: n/a
rim: n/a

period

0..1

There are no (further) constraints on this element

Element id

Organization.contact.telecom:email.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

phone

0..1

Element id

Organization.contact.telecom:phone

Short description

Telefonnummer

Definition

Die Telefonnummer des Ansprechpartners.

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: PID-13, PID-14
rim: ./telecom

0..1

There are no (further) constraints on this element

Element id

Organization.contact.telecom:phone.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.contact.telecom:phone.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ C

1..1

codeBindingFixed Value

Element id

Organization.contact.telecom:phone.system

Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Data type

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: cpt-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

phone

Mappings

v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

Organization.contact.telecom:phone.value

Short description

The actual contact point details

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.contact.telecom:phone.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

Binding

Use of contact point.

ContactPointUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..1

There are no (further) constraints on this element

Element id

Organization.contact.telecom:phone.rank

Short description

Specify preferred order of use (1 = highest)

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: n/a
rim: n/a

period

0..1

There are no (further) constraints on this element

Element id

Organization.contact.telecom:phone.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

address

0..1

Element id

Organization.contact.address

Short description

Adressinformationen

Definition

Enthält weitere Adressinformationen des Ansprechpartners.

Requirements

May need to keep track of a contact party's address for contacting, billing or reporting requirements.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: PID-11
rim: ./addr

0..1

There are no (further) constraints on this element

Element id

Organization.contact.address.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.contact.address.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.contact.address.use

Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

Binding

The use of an address.

AddressUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

home

Mappings

v2: XAD.7
rim: unique(./use)
servd: ./AddressPurpose

type

0..1

codeBinding

There are no (further) constraints on this element

Element id

Organization.contact.address.type

Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

Data type

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

both

Mappings

v2: XAD.18
rim: unique(./use)
vcard: address type parameter

text

0..1

There are no (further) constraints on this element

Element id

Organization.contact.address.text

Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

137 Nowhere Street, Erewhon 9132

Mappings

v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
rim: ./formatted
vcard: address label parameter

line

S Σ

0..1

Element id

Organization.contact.address.line

Short description

Abteilung

Definition

Die Abteilung des Ansprechpartners.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

137 Nowhere Street

Mappings

v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
rim: AD.part[parttype = AL]
vcard: street
servd: ./StreetAddress (newline delimitted)

city

0..1

There are no (further) constraints on this element

Element id

Organization.contact.address.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

The name of the city, town, suburb, village or other community or delivery center.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Erewhon

Mappings

v2: XAD.3
rim: AD.part[parttype = CTY]
vcard: locality
servd: ./Jurisdiction

district

0..1

There are no (further) constraints on this element

Element id

Organization.contact.address.district

Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Madison

Mappings

v2: XAD.9
rim: AD.part[parttype = CNT | CPA]

state

0..1

There are no (further) constraints on this element

Element id

Organization.contact.address.state

Short description

Sub-unit of country (abbreviations ok)

Alternate names

Province, Territory

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XAD.4
rim: AD.part[parttype = STA]
vcard: region
servd: ./Region

postalCode

0..1

There are no (further) constraints on this element

Element id

Organization.contact.address.postalCode

Short description

Postal code for area

Alternate names

Zip

Definition

A postal code designating a region defined by the postal service.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: XAD.5
rim: AD.part[parttype = ZIP]
vcard: code
servd: ./PostalIdentificationCode

country

0..1

There are no (further) constraints on this element

Element id

Organization.contact.address.country

Short description

Country (e.g. can be ISO 3166 2 or 3 letter code)

Definition

Country - a nation as commonly understood or generally accepted.

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: XAD.6
rim: AD.part[parttype = CNT]
vcard: country
servd: ./Country

period

0..1

There are no (further) constraints on this element

Element id

Organization.contact.address.period

Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}

Mappings

v2: XAD.12 / XAD.13 + XAD.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

endpoint

0..*

Reference(Endpoint)

There are no (further) constraints on this element

Element id

Organization.endpoint

Short description

Technical endpoints providing access to services operated for the organization

Definition

Technical endpoints providing access to services operated for the organization.

Requirements

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Data type

Reference(Endpoint)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

HealthAppModule

Das Profil HealthAppModule (DeviceDefinition) repräsentiert eines von ggf. mehreren Modulen einer DiGA und enthält modulspezifische Daten. Jedes Modul referenziert auf eine oder mehrere DiGA-Verordnungseinheiten (HealthAppPrescriptionUnit).

HealthAppModule (DeviceDefinition)

S C

Element id

DeviceDefinition

Short description

Modul einer digitalen Anwendung

Definition

In diesem Profil werden Informationen zu einem Modul einer digitalen Gesundheitsanwendung (DiGA) bzw. digitalen Pflegeanwendung (DiPA) repräsentiert.

Comments

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

DeviceDefinition.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

DeviceDefinition.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

DeviceDefinition.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

Element id

DeviceDefinition.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

HealthAppPrescriptionUnit

Das Profil HealthAppPrescriptionUnit (ChargeItemDefinition) repräsentiert eine von ggf. mehreren DiGA-Verordnungseinheiten.

HealthAppPrescriptionUnit (ChargeItemDefinition)

S C

ChargeItemDefinition

Element id

ChargeItemDefinition

Short description

Anwendungs- bzw. Verordnungseinheit

Definition

In diesem Profil werden Informationen zu einer Verordnungseinheit eines Moduls einer digitalen Gesundheitsanwendung (DiGA) bzw. zu einer Anwendungseinheit eines Moduls einer digitalen Pflegeanwendung (DiPA) repräsentiert.

Data type

ChargeItemDefinition

Constraints

cid-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act
rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

Element id

ChargeItemDefinition.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitAnwendungsdauer

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

anwendungsdauer

S C

0..1

Extension(Duration)

Element id

ChargeItemDefinition.extension:anwendungsdauer

Short description

Anwendungsdauer

Alternate names

extensions, user content

Definition

Nur DiGA: Enthält Angaben zur Dauer, über welche die Verordnungseinheit der digitalen Gesundheitsanwendung (DiGA) angewendet werden soll. Sind keine Angaben enthalten, dann ist die Nutzung der Anwendung ohne zeitliche Begrenzung möglich (Einmallizenz).

Comments

Data type

Extension(Duration)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

ergaenzendeUnterstuetzungsleistungen

S C

0..1

Extension(Complex)

Element id

ChargeItemDefinition.extension:ergaenzendeUnterstuetzungsleistungen

Short description

Ergänzende Unterstützungsleistungen

Alternate names

extensions, user content

Definition

Nur DiPA: Enthält Angaben dazu, ob ergänzende Unterstützungsleistungen zur Anwendungseinheit erforderlich sind.

Comments

Data type

Extension(Complex)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitErgaenzendeUnterstuetzungsleistungen

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

indikation

S C

0..1

Extension(Complex)

Element id

ChargeItemDefinition.extension:indikation

Short description

Indikationen

Alternate names

extensions, user content

Definition

Nur DiGA: Beinhaltet Informationen dazu, wann die Anwendung der Verordnungseinheit der digitalen Gesundheitsanwendung (DiGA) angezeigt ist.

Comments

Data type

Extension(Complex)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitIndikation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

kontraindikation

S C

0..1

Extension(Complex)

Element id

ChargeItemDefinition.extension:kontraindikation

Short description

Kontraindikationen

Alternate names

extensions, user content

Definition

Nur DiGA: Beinhaltet Informationen dazu, wann die Anwendung der Verordnungseinheit der digitalen Gesundheitsanwendung (DiGA) nicht angezeigt, also kontraindiziert ist.

Comments

Data type

Extension(Complex)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitKontraindikation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

vertragsaerztlicheLeistungen

S C

0..1

Extension(Complex)

Element id

ChargeItemDefinition.extension:vertragsaerztlicheLeistungen

Short description

Ergänzende vertragsärztlicher Leistungen

Alternate names

extensions, user content

Definition

Nur DiGA: Enthält Angaben dazu, ob ergänzende vertragsärztliche Leistungen zur Anwendungseinheit bzw. Verordnungseinheit erforderlich sind.

Comments

Data type

Extension(Complex)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitVertragsaerztlicheLeistungen

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

url

S Σ

1..1

Element id

ChargeItemDefinition.url

Short description

URL zum Verzeichnis

Definition

Enthält die URL zu einer der Anwendungs- bzw. Verordnungseinheit zugehörigen Information im Verzeichnis.

Requirements

Allows the charge item definition to be referenced by a single globally unique identifier.

Comments

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.url
w5: FiveWs.identifier
rim: N/A

identifier

S Σ

0..*

Element id

ChargeItemDefinition.identifier

Short description

IDs

Definition

Enthält Werte zur eindeutigen Identifizierung der Anwendungs- bzw. Verordnungseinheit.

Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this charge item definition outside of FHIR, where it is not possible to use the logical URI.

Data type

Slicing

Unordered, Open, by system(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.identifier
w5: FiveWs.identifier
rim: N/A
objimpl: no-gen-base

digaVeId

S Σ

0..1

Element id

ChargeItemDefinition.identifier:digaVeId

Short description

DiGA-VE-ID

Definition

DiGA-Verordnungseinheit-ID als eindeutiges Identifizierungsmerkmal der Verordnungseinheit der digitalen Gesundheitsanwendung (DiGA).

Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.identifier
w5: FiveWs.identifier
rim: N/A
objimpl: no-gen-base

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:digaVeId.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:digaVeId.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:digaVeId.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:digaVeId.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

uriFixed Value

Element id

ChargeItemDefinition.identifier:digaVeId.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

https://fhir.bfarm.de/Identifier/DigaVeId

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:digaVeId.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:digaVeId.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:digaVeId.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

dipaAeId

S Σ

0..1

Element id

ChargeItemDefinition.identifier:dipaAeId

Short description

DiPA-AE-ID

Definition

DiPA-Anwendungseinheit-ID als eindeutiges Identifizierungsmerkmal der Anwendungseinheit der digitalen Pflegeanwendung (DiPA).

Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.identifier
w5: FiveWs.identifier
rim: N/A
objimpl: no-gen-base

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:dipaAeId.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:dipaAeId.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:dipaAeId.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:dipaAeId.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

uriFixed Value

Element id

ChargeItemDefinition.identifier:dipaAeId.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

https://fhir.bfarm.de/Identifier/DipaAeId

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:dipaAeId.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:dipaAeId.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.identifier:dipaAeId.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

version

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.version

Short description

Business version of the charge item definition

Definition

The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.

Comments

There may be different charge item definition 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 charge item definition with the format [url]|[version].

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.version
w5: FiveWs.version
rim: N/A

title

S Σ

0..1

Element id

ChargeItemDefinition.title

Short description

Name

Definition

Die namentliche Bezeichnung der Anwendungs- bzw. Verordnungseinheit.

Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.title
rim: N/A

derivedFromUri

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.derivedFromUri

Short description

Underlying externally-defined charge item definition

Definition

The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

partOf

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.partOf

Short description

A larger definition of which this particular definition is a component or step

Alternate names

container

Definition

A larger definition of which this particular definition is a component or step.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

replaces

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.replaces

Short description

Completed or terminated request(s) whose function is taken by this new request

Alternate names

supersedes, prior, renewed order

Definition

As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

status

S Σ ?!

1..1

codeBinding

Element id

ChargeItemDefinition.status

Short description

Status (unknown)

Definition

Repräsentiert den Status der Anwendungs- bzw. Verordnungseinheit. Dieser ist hier immer auf unknown gesetzt. Ob eine Anwendungs- bzw. Verordnungseinheit zum aktuellen Zeitpunkt aktiv ist, ergibt sich aus der effectivePeriod.

Comments

Allows filtering of charge item definitions that are appropriate for use versus not.

Data type

Binding

The lifecycle status of an artifact.

PublicationStatus (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.status {different ValueSet}
w5: FiveWs.status
rim: N/A

experimental

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.experimental

Short description

For testing purposes, not real usage

Definition

A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level charge item definition.

Comments

Allows filtering of charge item definitions that are appropriate for use versus not.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.experimental
w5: FiveWs.class
rim: N/A

date

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.date

Short description

Date last changed

Alternate names

Revision Date

Definition

The date (and optionally time) when the charge item definition 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 charge item definition changes.

Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the charge item definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.date
w5: FiveWs.recorded
rim: N/A

publisher

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.publisher

Short description

Name of the publisher (organization or individual)

Definition

The name of the organization or individual that published the charge item definition.

Requirements

Helps establish the "authority/credibility" of the charge item definition. May also allow for contact.

Comments

Usually an organization but may be an individual. The publisher (or steward) of the charge item definition is the organization or individual primarily responsible for the maintenance and upkeep of the charge item definition. 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 charge item definition. This item SHOULD be populated unless the information is available from context.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.publisher {as string instead of CodeableConcept}
w5: FiveWs.witness
rim: N/A

contact

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.contact

Short description

Contact details for the publisher

Definition

Contact details to assist a user in finding and communicating with the publisher.

Comments

May be a web site, an email address, a telephone number, etc.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.contact
rim: N/A

description

S Σ

0..1

Element id

ChargeItemDefinition.description

Short description

Anmerkungen zum Preismodell

Definition

Enthält weitere optionale Erläuterungen zum Preismodell.

Comments

This description can be used to capture details such as why the charge item definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the charge item definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the charge item definition is presumed to be the predominant language in the place the charge item definition was created).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.description
rim: N/A

useContext

S Σ

0..*

Element id

ChargeItemDefinition.useContext

Short description

Patienten- und Zielgruppen

Definition

Enthält Angaben zu Patienten- und Zielgruppen, für welche die Anwendungseinheit bzw. Verordnungseinheit geeignet ist.

Requirements

Assist in searching for appropriate content.

Comments

This material includes SNOMED Clinical Terms® (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. SNOMED and SNOMED CT are registered trademarks of the IHTSDO.

Data type

Slicing

Unordered, Open, by code.code(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.useContext
rim: N/A

age

S Σ

0..*

Element id

ChargeItemDefinition.useContext:age

Short description

Altersgruppen

Definition

Angabe der Altersgruppen (der Patienten) für welche die Anwendungs- bzw. Verordnungseinheit geeignet ist.

Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.useContext
rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

code

S Σ

1..1

CodingBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.code

Short description

Type of context being specified

Definition

A code that identifies the type of context being specified by this usage context.

Data type

Binding

A code that specifies a type of context being specified by a usage context.

UsageContextType (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.code.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ

1..1

uriFixed Value

Element id

ChargeItemDefinition.useContext:age.code.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://terminology.hl7.org/CodeSystem/usage-context-type

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.code.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

codeFixed Value

Element id

ChargeItemDefinition.useContext:age.code.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

age

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

S Σ

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.code.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.code.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

Context of Use ValueSet (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

value[x]

S Σ

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.value[x]

Short description

Value that defines the context

Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Binding

A code that defines the specific value for the context being specified.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCodeableConcept

Data type

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.value[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:age.value[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

coding

S Σ

1..1

CodingHealthAppAge

Element id

ChargeItemDefinition.useContext:age.value[x].coding

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingHealthAppAge

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

text

S Σ

0..1

Element id

ChargeItemDefinition.useContext:age.value[x].text

Short description

Kommentar

Definition

Kommentar zur Altersgruppe.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

focus

S Σ

0..*

Element id

ChargeItemDefinition.useContext:focus

Short description

Beeinträchtigungen

Definition

Nur DiPA: Angabe der Dimensionen der Beeinträchtigungen (der Patienten) für welche die Anwendungseinheit geeignet ist.

Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.useContext
rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

code

S Σ

1..1

CodingBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.code

Short description

Type of context being specified

Definition

A code that identifies the type of context being specified by this usage context.

Data type

Binding

A code that specifies a type of context being specified by a usage context.

UsageContextType (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.code.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ

1..1

uriFixed Value

Element id

ChargeItemDefinition.useContext:focus.code.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://terminology.hl7.org/CodeSystem/usage-context-type

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.code.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

codeFixed Value

Element id

ChargeItemDefinition.useContext:focus.code.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

focus

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

S Σ

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.code.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.code.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Context of Use ValueSet (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

value[x]

S Σ

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.value[x]

Short description

Value that defines the context

Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Binding

A code that defines the specific value for the context being specified.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCodeableConcept

Data type

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.value[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.value[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension(CodingHealthAppSeverity)

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

severity

S C

0..*

Element id

ChargeItemDefinition.useContext:focus.value[x].extension:severity

Short description

Ausprägungsgrad

Alternate names

extensions, user content

Definition

Nur DiPA: Optionaler Ausprägungsgrad der Dimension der Beeinträchtigung.

Comments

Data type

Extension(CodingHealthAppSeverity)

Extension URL

https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitUseContextValueSeverity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

S Σ

1..1

CodingHealthAppFocus

Element id

ChargeItemDefinition.useContext:focus.value[x].coding

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingHealthAppFocus

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

text

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:focus.value[x].text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

gender

S Σ

0..*

Element id

ChargeItemDefinition.useContext:gender

Short description

Geschlechter

Definition

Angabe der Geschlechter (der Patienten) für welche die Anwendungs- bzw. Verordnungseinheit geeignet ist.

Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.useContext
rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

code

S Σ

1..1

CodingBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.code

Short description

Type of context being specified

Definition

A code that identifies the type of context being specified by this usage context.

Data type

Binding

A code that specifies a type of context being specified by a usage context.

UsageContextType (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.code.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ

1..1

uriFixed Value

Element id

ChargeItemDefinition.useContext:gender.code.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://terminology.hl7.org/CodeSystem/usage-context-type

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.code.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

codeFixed Value

Element id

ChargeItemDefinition.useContext:gender.code.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

gender

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

S Σ

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.code.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.code.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Context of Use ValueSet (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

value[x]

S Σ

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.value[x]

Short description

Value that defines the context

Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Binding

A code that defines the specific value for the context being specified.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

valueCodeableConcept

Data type

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.value[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.value[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

coding

S Σ

1..1

CodingHealthAppGender

Element id

ChargeItemDefinition.useContext:gender.value[x].coding

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingHealthAppGender

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

text

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.useContext:gender.value[x].text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

jurisdiction

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.jurisdiction

Short description

Intended jurisdiction for charge item definition (if applicable)

Definition

A legal or geographic region in which the charge item definition is intended to be used.

Comments

It may be possible for the charge item definition to be used in jurisdictions other than those for which it was originally designed or intended.

Data type

Jurisdiction ValueSet (extensible)

Binding

Countries and regions within which this artifact is targeted for use.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.jurisdiction
rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.copyright

Short description

Use and/or publishing restrictions

Alternate names

License, Restrictions

Definition

A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.

Requirements

Consumers must be able to determine any legal restrictions on the use of the charge item definition and/or its content.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.copyright
rim: N/A
objimpl: no-gen-base

approvalDate

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.approvalDate

Short description

When the charge item definition was approved by publisher

Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.approvalDate
rim: N/A
objimpl: no-gen-base

lastReviewDate

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.lastReviewDate

Short description

When the charge item definition was last reviewed

Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.lastReviewDate
rim: N/A
objimpl: no-gen-base

effectivePeriod

S Σ

0..1

Element id

ChargeItemDefinition.effectivePeriod

Short description

Gültigkeitsdauer

Definition

Gibt an in welchem Zeitraum die Anwendungs- bzw. Verordnungseinheit gültig ist.

Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the charge item definition are or are expected to be used instead.

Comments

The effective period for a charge item definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.effectivePeriod
rim: N/A
objimpl: no-gen-base

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.effectivePeriod.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.effectivePeriod.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

start

S Σ C

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.effectivePeriod.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: DR.1
rim: ./low

end

S Σ C

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.effectivePeriod.end

Short description

End time with inclusive boundary, if not ongoing

Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: DR.2
rim: ./high

code

S Σ

0..1

Element id

ChargeItemDefinition.code

Short description

Codierung

Definition

Nur DiGA: Codiert die Verordnungseinheit einer digitalen Gesundheitsanwendung (DiGA), beispielsweise in Form der Pharmazentralnummer (PZN).

Data type

Binding

Billing Code defined by this ChargeItemDefinition.

ChargeItemCode (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

coding

S Σ

1..1

CodingPZN

Element id

ChargeItemDefinition.code.coding

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingPZN

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

S Σ

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.coding.system

Short description

Canonische CodeSystem URL für PZN

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://fhir.de/CodeSystem/ifa/pzn

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.coding.code

Short description

Der PZN-Code

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.code.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

instance

1..1

Reference(Medication | Substance | Device)

Element id

ChargeItemDefinition.instance

Short description

HealthAppModule

Definition

Die Referenz zum übergeordneten Modul der digitalen Anwendung (HealthAppModule).

Comments

In case of highly customized, individually produced or fitted devices/substances, the pricing information may be different for each instance of the product. This reference links pricing details to specific product instances.

Data type

Reference(Medication | Substance | Device)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.instance.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

1..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.instance.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitHealthAppModuleLink

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

deviceDefinition

S C

1..1

Extension(Reference(HealthAppModule))

Element id

ChargeItemDefinition.instance.extension:deviceDefinition

Short description

Verweis

Alternate names

extensions, user content

Definition

Der Verweis auf das Modul der digitalen Anwendung (HealthAppModule).

Comments

Data type

Extension(Reference(HealthAppModule))

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.instance.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.instance.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.instance.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.instance.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

applicability

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.applicability

Short description

Whether or not the billing code is applicable

Definition

Expressions that describe applicability criteria for the billing code.

Comments

The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.applicability.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.applicability.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.applicability.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

description

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.applicability.description

Short description

Natural language description of the condition

Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

language

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.applicability.language

Short description

Language of the expression

Definition

The media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

expression

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.applicability.expression

Short description

Boolean-valued expression

Definition

An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.

Comments

Please note that FHIRPath Expressions can only be evaluated in the scope of the current ChargeItem resource to which this definition is being applied. FHIRPath expressions can traverse into other resources linked from the ChargeItem resource, however, testing rules such as that a billing code may be billed only once per encounter need a wider scope. In such scenarios, CQL may be the appropriate choice.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

propertyGroup

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup

Short description

Group of properties which are applicable under the same conditions

Definition

Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

ChargeItemDefinition.propertyGroup.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

nonRefundable

S C

0..1

Extension(Complex)

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable

Short description

Nicht-erstattungsfähige Kosten

Alternate names

extensions, user content

Definition

Enthält Angaben zu Kosten der Anwendungs- bzw. Verordnungseinheit, die nicht (z.B. durch die Gesetzliche Krankenversicherung) erstattet werden können.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

1..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

description

S C

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:description

Short description

Beschreibung

Alternate names

extensions, user content

Definition

Die Beschreibung der nicht-erstattungsfähigen Kosten in Textform, falls die Anwendungseinheit bzw. Verordnungseinheit nicht-erstattungsfähige Kostenbestandteile enthält.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:description.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:description.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:description.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

Fixed value

description

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:description.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

valueString

There are no (further) constraints on this element

Data type

required

S C

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:required

Short description

Vorhandensein nicht-erstattungsfähiger Kosten (true | false)

Alternate names

extensions, user content

Definition

Gibt an, ob die Kosten der Anwendungseinheit bzw. Verordnungseinheit nicht-erstattungsfähige Bestandteile enthalten:

true: nicht-erstattungsfähige Kosten enthalten
false: keine nicht-erstattungsfähigen Kosten enthalten / alle Kosten werden erstattet

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:required.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:required.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:required.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Fixed value

required

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.extension:required.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

valueBoolean

There are no (further) constraints on this element

Data type

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Fixed value

https://fhir.bfarm.de/StructureDefinition/HealthAppPrescriptionUnitPropertyGroupNonRefundable

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.extension:nonRefundable.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

applicability

0..*

see (applicability)

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.applicability

Short description

Conditions under which the priceComponent is applicable

Definition

Expressions that describe applicability criteria for the priceComponent.

Comments

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

priceComponent

0..*

Element id

ChargeItemDefinition.propertyGroup.priceComponent

Short description

Preisangaben

Definition

Enthält Angaben zum Preis der Anwendungs- bzw. Verordnungseinheit.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

type

1..1

codeBinding

Element id

ChargeItemDefinition.propertyGroup.priceComponent.type

Short description

Preisbestandteil (Typ)

Definition

Typ des Preisbestandteils:

informational: Bruttopreis inkl. Mehrwertsteuer

Data type

InvoicePriceComponentType (required)

Binding

Codes indicating the kind of the price component.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

code

0..1

Element id

ChargeItemDefinition.propertyGroup.priceComponent.code

Short description

Preisbestandteil (Bezeichnung)

Definition

Bezeichnung des Preisbestandteils:

additional-costs: Mehrkosten bei alleiniger Nutzung (nur DiPA)
compensation-amount: Verhandelter Vergütungsbetrag (nur DiPA)
maximum-amount: Vergütungs- / Höchstbetrag (nur DiGA)
publisher-price: Herstellerpreis (nur DiGA)

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.code.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

coding

S Σ

0..1

CodingHealthAppPriceCode

Element id

ChargeItemDefinition.propertyGroup.priceComponent.code.coding

Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

CodingHealthAppPriceCode

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

text

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.code.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

factor

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.factor

Short description

Factor used for calculating this component

Definition

The factor that has been applied on the base price for calculating this component.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

amount

0..1

Money

Element id

ChargeItemDefinition.propertyGroup.priceComponent.amount

Short description

Betrag

Definition

Enthält den Betrag des jeweiligen Preisbestandteils.

Data type

Money

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.amount.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.amount.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

value

S Σ

0..1

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.amount.value

Short description

Numerical value (with implicit precision)

Definition

Numerical value (with implicit precision).

Requirements

The amount of the currency. The value includes an implicit precision in the presentation of the value.

Comments

Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: MO.Value

currency

S Σ

0..1

codeBinding

There are no (further) constraints on this element

Element id

ChargeItemDefinition.propertyGroup.priceComponent.amount.currency

Short description

ISO 4217 Currency Code

Definition

ISO 4217 Currency Code.

Requirements

A code indicating the currency, taken from ISO 4217.

Data type

Binding

A code indicating the currency, taken from ISO 4217.

Currencies (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: MO.Currency

HealthAppQuestionnaire

Das Profil HealthAppQuestionnaire (Questionnaire) repräsentiert einen DiGA-Fragenkatalog aus dem elektronischen Antragsportal.

HealthAppQuestionnaire (Questionnaire)

S C

Questionnaire

Element id

Questionnaire

Short description

Fragenkatalog

Alternate names

Form, CRF, Survey

Definition

In diesem Profil wird ein Fragenkatalog repräsentiert welcher im Zuge eines Antrags auf Aufnahme ins DiGA- bzw. DiPA-Verzeichnis vom Hersteller einer digitalen Gesundheitsanwendung (DiGA) bzw. digitalen Pflegeanwendung (DiPA) beantwortet wird.

Data type

Questionnaire

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-2: The link ids for groups and questions must be unique within the questionnaire
descendants().linkId.isDistinct()

Mappings

rim: Entity. Role, or Act
workflow: Definition
rim: Observation[moodCode=DEF]

0..1

There are no (further) constraints on this element

Element id

Questionnaire.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Questionnaire.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Questionnaire.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

Questionnaire.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

Questionnaire.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

url

S Σ

1..1

Element id

Questionnaire.url

Short description

URL

Definition

Die URL des Fragenkatalogs.

Requirements

… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.

Comments

The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.url
w5: FiveWs.identifier
rim: .identifier[scope=BUSN;reliability=ISS]

identifier

S Σ

1..*

Element id

Questionnaire.identifier

Short description

IDs

Definition

Enthält Werte zur eindeutigen Identifizierung eines Fragenkatalogs.

Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.

Data type

Slicing

Unordered, Open, by system(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.identifier
w5: FiveWs.identifier
rim: .identifier
objimpl: no-gen-base

healthAppQuestionnaireId

1..1

There are no (further) constraints on this element

Element id

Questionnaire.identifier:healthAppQuestionnaireId

Short description

Additional identifier for the questionnaire

Definition

A formal identifier that is used to identify this questionnaire 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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.identifier
w5: FiveWs.identifier
rim: .identifier
objimpl: no-gen-base

0..1

There are no (further) constraints on this element

Element id

Questionnaire.identifier:healthAppQuestionnaireId.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.identifier:healthAppQuestionnaireId.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.identifier:healthAppQuestionnaireId.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Questionnaire.identifier:healthAppQuestionnaireId.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

uriFixed Value

Element id

Questionnaire.identifier:healthAppQuestionnaireId.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

https://fhir.bfarm.de/Identifier/HealthAppQuestionnaireId

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

Questionnaire.identifier:healthAppQuestionnaireId.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Questionnaire.identifier:healthAppQuestionnaireId.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Questionnaire.identifier:healthAppQuestionnaireId.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

version

0..1

There are no (further) constraints on this element

Element id

Questionnaire.version

Short description

Business version of the questionnaire

Definition

The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire 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.

Comments

There may be different questionnaire 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 questionnaire with the format [url]|[version].

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.version
w5: FiveWs.version
rim: N/A (to add?)

name

Σ C

0..1

There are no (further) constraints on this element

Element id

Questionnaire.name

Short description

Name for this questionnaire (computer friendly)

Definition

A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Requirements

Support human navigation and code generation.

Comments

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: inv-0

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

title

S Σ

0..1

Element id

Questionnaire.title

Short description

Name

Definition

Der Name des Fragenkatalogs.

Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.title
rim: .title

derivedFrom

0..*

There are no (further) constraints on this element

Element id

Questionnaire.derivedFrom

Short description

Instantiates protocol or definition

Definition

The URL of a Questionnaire that this Questionnaire is based on.

Requirements

Allows a Questionnaire to be created based on another Questionnaire.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.derivedFrom
rim: .outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]

status

S Σ ?!

1..1

codeBinding

Element id

Questionnaire.status

Short description

Status (unknown)

Definition

Der Status des Fragenkatalogs. Dieser ist hier immer auf unknown gesetzt.

Comments

Allows filtering of questionnaires that are appropriate for use versus not.

Data type

Binding

The lifecycle status of an artifact.

PublicationStatus (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.status
w5: FiveWs.status
rim: .status

experimental

0..1

There are no (further) constraints on this element

Element id

Questionnaire.experimental

Short description

For testing purposes, not real usage

Definition

A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.

Comments

Allows filtering of questionnaires that are appropriate for use versus not.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.experimental
w5: FiveWs.class
rim: N/A

subjectType

0..*

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.subjectType

Short description

Resource that can be subject of QuestionnaireResponse

Definition

The types of subjects that can be the subject of responses created for the questionnaire.

Comments

If none are specified, then the subject is unlimited.

Data type

Binding

One of the resource types defined as part of this version of FHIR.

ResourceType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.subject[x]
rim: .outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode

date

S Σ

0..1

Element id

Questionnaire.date

Short description

Datum

Alternate names

Revision Date

Definition

Das Datum der letzten Veröffentlichung bzw. Änderung.

Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.date
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

publisher

0..1

There are no (further) constraints on this element

Element id

Questionnaire.publisher

Short description

Name of the publisher (organization or individual)

Definition

The name of the organization or individual that published the questionnaire.

Requirements

Helps establish the "authority/credibility" of the questionnaire. May also allow for contact.

Comments

Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. 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 questionnaire. This item SHOULD be populated unless the information is available from context.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.publisher
w5: FiveWs.witness
rim: .participation[typeCode=AUT].role

contact

0..*

There are no (further) constraints on this element

Element id

Questionnaire.contact

Short description

Contact details for the publisher

Definition

Contact details to assist a user in finding and communicating with the publisher.

Comments

May be a web site, an email address, a telephone number, etc.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.contact
rim: .participation[typeCode=CALLBCK].role

description

0..1

Element id

Questionnaire.description

Short description

Beschreibung

Definition

Die Beschreibung des Fragenkatalogs.

Comments

This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.description
rim: .text

useContext

0..*

There are no (further) constraints on this element

Element id

Questionnaire.useContext

Short description

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 questionnaire instances.

Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.useContext
rim: N/A (to add?)

jurisdiction

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Questionnaire.jurisdiction

Short description

Intended jurisdiction for questionnaire (if applicable)

Definition

A legal or geographic region in which the questionnaire is intended to be used.

Comments

It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.

Data type

Jurisdiction ValueSet (extensible)

Binding

Countries and regions within which this artifact is targeted for use.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.jurisdiction
rim: N/A (to add?)

purpose

0..1

There are no (further) constraints on this element

Element id

Questionnaire.purpose

Short description

Why this questionnaire is defined

Definition

Explanation of why this questionnaire is needed and why it has been designed as it has.

Comments

This element does not describe the usage of the questionnaire. 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 questionnaire.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.purpose
w5: FiveWs.why[x]
rim: .reasonCode.text
objimpl: no-gen-base

0..1

There are no (further) constraints on this element

Element id

Questionnaire.copyright

Short description

Use and/or publishing restrictions

Alternate names

License, Restrictions

Definition

A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.

Requirements

Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.copyright
rim: N/A (to add?)
objimpl: no-gen-base

approvalDate

0..1

There are no (further) constraints on this element

Element id

Questionnaire.approvalDate

Short description

When the questionnaire was approved by publisher

Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.approvalDate
rim: .outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime
objimpl: no-gen-base

lastReviewDate

0..1

There are no (further) constraints on this element

Element id

Questionnaire.lastReviewDate

Short description

When the questionnaire was last reviewed

Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.lastReviewDate
rim: .outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime
objimpl: no-gen-base

effectivePeriod

0..1

There are no (further) constraints on this element

Element id

Questionnaire.effectivePeriod

Short description

When the questionnaire is expected to be used

Definition

The period during which the questionnaire content was or is planned to be in active use.

Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead.

Comments

The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Definition.effectivePeriod
rim: N/A (to add?)
objimpl: no-gen-base

code

0..*

There are no (further) constraints on this element

Element id

Questionnaire.code

Short description

Concept that represents the overall questionnaire

Definition

An identifier for this question or group of questions in a particular terminology such as LOINC.

Requirements

Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code.

Data type

Binding

Codes for questionnaires, groups and individual questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .code

item

S C

0..*

Element id

Questionnaire.item

Short description

Assessments

Definition

Die erste Ebene des Fragenkatalogs.

Comments

The content of the questionnaire is constructed from an ordered, hierarchical collection of items.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
que-1: Group items must have nested items, display items cannot have nested items
(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())
que-3: Display items cannot have a "code" asserted
type!='display' or code.empty()
que-4: A question cannot have both answerOption and answerValueSet
answerOption.empty() or answerValueSet.empty()
que-5: Only 'choice' and 'open-choice' items can have answerValueSet
(type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-6: Required and repeat aren't permitted for display items
type!='display' or (required.empty() and repeats.empty())
que-8: Initial values can't be specified for groups or display items
(type!='group' and type!='display') or initial.empty()
que-9: Read-only can't be specified for "display" items
type!='display' or readOnly.empty()
que-10: Maximum length can only be declared for simple question types
(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11: If one or more answerOption is present, initial[x] must be missing
answerOption.empty() or initial.empty()
que-12: If there are more than one enableWhen, enableBehavior must be specified
enableWhen.count() > 2 implies enableBehavior.exists()
que-13: Can only have multiple initial values for repeating items
repeats=true or initial.count() <= 1

Mappings

rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Questionnaire.item.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaireItemDescription

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

description

S C

0..1

Extension(Complex)

Element id

Questionnaire.item.extension:description

Short description

Beschreibungstexte

Alternate names

extensions, user content

Definition

Zusätzliche Beschreibungstexte des Items.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

linkId

1..1

Element id

Questionnaire.item.linkId

Short description

Assessment-ID

Definition

Die eindeutige ID des Assessments.

Requirements

QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.

Comments

This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .id

definition

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.definition

Short description

ElementDefinition - details for the item

Definition

This element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:

code (ElementDefinition.code)
type (ElementDefinition.type)
required (ElementDefinition.min)
repeats (ElementDefinition.max)
maxLength (ElementDefinition.maxLength)
answerValueSet (ElementDefinition.binding)
options (ElementDefinition.binding).

Requirements

A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.

Comments

The uri refers to an ElementDefinition in a StructureDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id Element.id. E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]

code

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.code

Short description

Corresponding concept for this item in a terminology

Definition

A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).

Requirements

Allows linking of groups of questions to formal terminologies.

Comments

The value may come from the ElementDefinition referred to by .definition.

Data type

Binding

Codes for questionnaires, groups and individual questions.

Conditions

The cardinality or value of this element may be affected by these constraints: que-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .code

prefix

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.prefix

Short description

E.g. "1(a)", "2.5.3"

Alternate names

label

Definition

A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

Requirements

Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.

Comments

These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for "display" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Not supported

text

0..1

Element id

Questionnaire.item.text

Short description

Name

Definition

Der Name des Assessments.

Comments

When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .text

type

1..1

codeBindingFixed Value

Element id

Questionnaire.item.type

Short description

Fragentyp

Definition

Der Typ des Items.

group: Ein Element ohne direkt Antwort, enthält untergeordnete Elemente.

Requirements

Defines the format in which the user is to be prompted for the answer.

Comments

Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.

Data type

QuestionnaireItemType (required)

Binding

Distinguishes groups from questions and display text and indicates data type for questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

group

Mappings

rim: N/A - MIF rather than RIM level

enableWhen

?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen

Short description

Only allow data when

Definition

A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

Requirements

Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.

Comments

If multiple repetitions of this extension are present, the item should be enabled when the condition for any of the repetitions is true. I.e. treat "enableWhen"s as being joined by an "or" clause. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
que-7: If the operator is 'exists', the value must be a boolean
operator = 'exists' implies (answer is Boolean)

Mappings

rim: N/A - MIF rather than RIM level

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

question

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.question

Short description

Question that determines whether item is enabled

Definition

The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.

Comments

If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

operator

1..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.operator

Short description

exists | = | != | > | < | >= | <=

Definition

Specifies the criteria by which the question is enabled.

Data type

QuestionnaireItemOperator (required)

Binding

The criteria by which a question is enabled.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

answer[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.answer[x]

Short description

Value for question comparison based on operator

Definition

A value that the referenced question is tested using the specified operator in order for the item to be enabled.

Binding

Allowed values to answer questions.

Conditions

The cardinality or value of this element may be affected by these constraints: que-7

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

answerBoolean

There are no (further) constraints on this element

Data type

answerDecimal

There are no (further) constraints on this element

Data type

answerInteger

There are no (further) constraints on this element

Data type

answerDate

There are no (further) constraints on this element

Data type

answerDateTime

There are no (further) constraints on this element

Data type

answerTime

There are no (further) constraints on this element

Data type

answerString

There are no (further) constraints on this element

Data type

answerCoding

There are no (further) constraints on this element

Data type

answerQuantity

There are no (further) constraints on this element

Data type

answerReference

There are no (further) constraints on this element

Data type

enableBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.enableBehavior

Short description

all | any

Definition

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

Comments

This element must be specified if more than one enableWhen value is provided.

Data type

Binding

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

EnableWhenBehavior (required)

Conditions

The cardinality or value of this element may be affected by these constraints: que-12

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

required

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.required

Short description

Whether the item must be included in data results

Definition

An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

Comments

Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition.

Meaning when missing

Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

repeats

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.repeats

Short description

Whether the item may repeat

Definition

An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.

Requirements

Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.

Comments

If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.

The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.

The value may come from the ElementDefinition referred to by .definition.

Meaning when missing

Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

readOnly

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.readOnly

Short description

Don't allow human editing

Definition

An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

Requirements

Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.

Comments

The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-9

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

maxLength

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.maxLength

Short description

No more than this many characters

Definition

The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

Comments

For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-10

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: N/A - MIF rather than RIM level

answerValueSet

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.answerValueSet

Short description

Valueset containing permitted answers

Definition

A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.

Comments

LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-4, que-5

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

answerOption

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption

Short description

Permitted answer

Definition

One of the permitted answers for a "choice" or "open-choice" question.

Comments

This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-4, que-5

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.value[x]

Short description

Answer value

Definition

A potential answer that's allowed as the answer to this question.

Comments

The data type of the value must agree with the item.type.

Binding

Allowed values to answer questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

valueInteger

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

initialSelected

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.initialSelected

Short description

Whether option is selected by default

Definition

Indicates whether the answer value is selected when the list of possible answers is initially shown.

Comments

Use this instead of initial[v] if answerValueSet is present.

Meaning when missing

Only selected items explicitly marked to be selected

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

initial

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.initial

Short description

Initial value(s) when item is first rendered

Definition

One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.

Requirements

In some workflows, having defaults saves time.

Comments

The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-8, que-13

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.value[x]

Short description

Actual value for initializing the question

Definition

The actual value to for an initial answer.

Comments

The type of the initial value must be consistent with the type of the item.

Binding

Allowed values to answer questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

valueBoolean

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

item

S C

0..*

see (item)

Element id

Questionnaire.item.item

Short description

Questionblocks

Definition

Die zweite Ebene des Fragenkatalogs.

Requirements

Reports can consist of complex nested groups.

Comments

There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.

Conditions

The cardinality or value of this element may be affected by these constraints: que-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=COMP].target

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Questionnaire.item.item.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaireItemDescription

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

description

S C

0..1

Extension(Complex)

Element id

Questionnaire.item.item.extension:description

Short description

Beschreibungstexte

Alternate names

extensions, user content

Definition

Zusätzliche Beschreibungstexte des Items.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

linkId

1..1

Element id

Questionnaire.item.item.linkId

Short description

Questionblock-ID

Definition

Die eindeutige ID des Questionblocks.

Requirements

QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.

Comments

This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .id

definition

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.definition

Short description

ElementDefinition - details for the item

Definition

code (ElementDefinition.code)
type (ElementDefinition.type)
required (ElementDefinition.min)
repeats (ElementDefinition.max)
maxLength (ElementDefinition.maxLength)
answerValueSet (ElementDefinition.binding)
options (ElementDefinition.binding).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]

code

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.code

Short description

Corresponding concept for this item in a terminology

Definition

A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).

Requirements

Allows linking of groups of questions to formal terminologies.

Comments

The value may come from the ElementDefinition referred to by .definition.

Data type

Binding

Codes for questionnaires, groups and individual questions.

Conditions

The cardinality or value of this element may be affected by these constraints: que-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .code

prefix

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.prefix

Short description

E.g. "1(a)", "2.5.3"

Alternate names

label

Definition

A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Not supported

text

0..1

Element id

Questionnaire.item.item.text

Short description

Name

Definition

Der Name des Questionblocks.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .text

type

1..1

codeBindingFixed Value

Element id

Questionnaire.item.item.type

Short description

Fragentyp

Definition

Der Typ des Items.

group: Ein Element ohne direkt Antwort, enthält untergeordnete Elemente.

Requirements

Defines the format in which the user is to be prompted for the answer.

Comments

Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.

Data type

QuestionnaireItemType (required)

Binding

Distinguishes groups from questions and display text and indicates data type for questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

group

Mappings

rim: N/A - MIF rather than RIM level

enableWhen

?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.enableWhen

Short description

Only allow data when

Definition

A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
que-7: If the operator is 'exists', the value must be a boolean
operator = 'exists' implies (answer is Boolean)

Mappings

rim: N/A - MIF rather than RIM level

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.enableWhen.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.enableWhen.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.enableWhen.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

question

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.enableWhen.question

Short description

Question that determines whether item is enabled

Definition

The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

operator

1..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.item.enableWhen.operator

Short description

exists | = | != | > | < | >= | <=

Definition

Specifies the criteria by which the question is enabled.

Data type

QuestionnaireItemOperator (required)

Binding

The criteria by which a question is enabled.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

answer[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.enableWhen.answer[x]

Short description

Value for question comparison based on operator

Definition

A value that the referenced question is tested using the specified operator in order for the item to be enabled.

Binding

Allowed values to answer questions.

Conditions

The cardinality or value of this element may be affected by these constraints: que-7

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

answerBoolean

There are no (further) constraints on this element

Data type

answerDecimal

There are no (further) constraints on this element

Data type

answerInteger

There are no (further) constraints on this element

Data type

answerDate

There are no (further) constraints on this element

Data type

answerDateTime

There are no (further) constraints on this element

Data type

answerTime

There are no (further) constraints on this element

Data type

answerString

There are no (further) constraints on this element

Data type

answerCoding

There are no (further) constraints on this element

Data type

answerQuantity

There are no (further) constraints on this element

Data type

answerReference

There are no (further) constraints on this element

Data type

enableBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.item.enableBehavior

Short description

all | any

Definition

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

Comments

This element must be specified if more than one enableWhen value is provided.

Data type

Binding

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

EnableWhenBehavior (required)

Conditions

The cardinality or value of this element may be affected by these constraints: que-12

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

required

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.required

Short description

Whether the item must be included in data results

Definition

An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

Comments

Meaning when missing

Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

repeats

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.repeats

Short description

Whether the item may repeat

Definition

An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.

Requirements

Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.

Comments

The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.

The value may come from the ElementDefinition referred to by .definition.

Meaning when missing

Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

readOnly

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.readOnly

Short description

Don't allow human editing

Definition

An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

Requirements

Comments

The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-9

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

maxLength

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.maxLength

Short description

No more than this many characters

Definition

The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-10

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: N/A - MIF rather than RIM level

answerValueSet

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.answerValueSet

Short description

Valueset containing permitted answers

Definition

A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.

Comments

LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-4, que-5

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

answerOption

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.answerOption

Short description

Permitted answer

Definition

One of the permitted answers for a "choice" or "open-choice" question.

Comments

This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-4, que-5

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.answerOption.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.answerOption.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.answerOption.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.answerOption.value[x]

Short description

Answer value

Definition

A potential answer that's allowed as the answer to this question.

Comments

The data type of the value must agree with the item.type.

Binding

Allowed values to answer questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

valueInteger

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

initialSelected

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.answerOption.initialSelected

Short description

Whether option is selected by default

Definition

Indicates whether the answer value is selected when the list of possible answers is initially shown.

Comments

Use this instead of initial[v] if answerValueSet is present.

Meaning when missing

Only selected items explicitly marked to be selected

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

initial

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.initial

Short description

Initial value(s) when item is first rendered

Definition

One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.

Requirements

In some workflows, having defaults saves time.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-8, que-13

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.initial.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.initial.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.initial.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.initial.value[x]

Short description

Actual value for initializing the question

Definition

The actual value to for an initial answer.

Comments

The type of the initial value must be consistent with the type of the item.

Binding

Allowed values to answer questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

valueBoolean

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

item

S C

0..*

see (item)

Element id

Questionnaire.item.item.item

Short description

Questions

Definition

Die dritte Ebene des Fragenkatalogs.

Requirements

Reports can consist of complex nested groups.

Comments

There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.

Conditions

The cardinality or value of this element may be affected by these constraints: que-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=COMP].target

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Questionnaire.item.item.item.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaireItemDescription

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

description

S C

0..1

Extension(Complex)

Element id

Questionnaire.item.item.item.extension:description

Short description

Beschreibungstexte

Alternate names

extensions, user content

Definition

Zusätzliche Beschreibungstexte des Items.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

linkId

1..1

Element id

Questionnaire.item.item.item.linkId

Short description

Question-ID

Definition

Die eindeutige ID der Question.

Requirements

QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.

Comments

This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .id

definition

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.definition

Short description

ElementDefinition - details for the item

Definition

code (ElementDefinition.code)
type (ElementDefinition.type)
required (ElementDefinition.min)
repeats (ElementDefinition.max)
maxLength (ElementDefinition.maxLength)
answerValueSet (ElementDefinition.binding)
options (ElementDefinition.binding).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]

code

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.code

Short description

Corresponding concept for this item in a terminology

Definition

A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).

Requirements

Allows linking of groups of questions to formal terminologies.

Comments

The value may come from the ElementDefinition referred to by .definition.

Data type

Binding

Codes for questionnaires, groups and individual questions.

Conditions

The cardinality or value of this element may be affected by these constraints: que-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .code

prefix

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.prefix

Short description

E.g. "1(a)", "2.5.3"

Alternate names

label

Definition

A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Not supported

text

0..1

Element id

Questionnaire.item.item.item.text

Short description

Fragestellung

Definition

Die Fragestellung der Question.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .text

type

1..1

codeBinding

Element id

Questionnaire.item.item.item.type

Short description

Fragentyp

Definition

Der Typ des Items.

text: Frage mit einer Freitext-Antwort oder einer Wertebereich-Antwort (Range).
choice: Fragen mit einer oder mehrerer Antworten aus einer vorgegebenen Auswahl.
open-choice: Fragen mit einer oder mehrerer Antworten aus einer vorgegebenen Auswahl sowie einer optionalen sonstigen Antwort als Freitext.
attachment: Dateiuploads

Requirements

Defines the format in which the user is to be prompted for the answer.

Comments

Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.

Data type

QuestionnaireItemType (required)

Binding

Distinguishes groups from questions and display text and indicates data type for questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

enableWhen

?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.enableWhen

Short description

Only allow data when

Definition

A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
que-7: If the operator is 'exists', the value must be a boolean
operator = 'exists' implies (answer is Boolean)

Mappings

rim: N/A - MIF rather than RIM level

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.enableWhen.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.enableWhen.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.enableWhen.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

question

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.enableWhen.question

Short description

Question that determines whether item is enabled

Definition

The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

operator

1..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.enableWhen.operator

Short description

exists | = | != | > | < | >= | <=

Definition

Specifies the criteria by which the question is enabled.

Data type

QuestionnaireItemOperator (required)

Binding

The criteria by which a question is enabled.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

answer[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.enableWhen.answer[x]

Short description

Value for question comparison based on operator

Definition

A value that the referenced question is tested using the specified operator in order for the item to be enabled.

Binding

Allowed values to answer questions.

Conditions

The cardinality or value of this element may be affected by these constraints: que-7

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

answerBoolean

There are no (further) constraints on this element

Data type

answerDecimal

There are no (further) constraints on this element

Data type

answerInteger

There are no (further) constraints on this element

Data type

answerDate

There are no (further) constraints on this element

Data type

answerDateTime

There are no (further) constraints on this element

Data type

answerTime

There are no (further) constraints on this element

Data type

answerString

There are no (further) constraints on this element

Data type

answerCoding

There are no (further) constraints on this element

Data type

answerQuantity

There are no (further) constraints on this element

Data type

answerReference

There are no (further) constraints on this element

Data type

enableBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.enableBehavior

Short description

all | any

Definition

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

Comments

This element must be specified if more than one enableWhen value is provided.

Data type

Binding

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

EnableWhenBehavior (required)

Conditions

The cardinality or value of this element may be affected by these constraints: que-12

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

required

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.required

Short description

Whether the item must be included in data results

Definition

An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

Comments

Meaning when missing

Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

repeats

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.repeats

Short description

Whether the item may repeat

Definition

An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.

Requirements

Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.

Comments

The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.

The value may come from the ElementDefinition referred to by .definition.

Meaning when missing

Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-6

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

readOnly

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.readOnly

Short description

Don't allow human editing

Definition

An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

Requirements

Comments

The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-9

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

maxLength

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.maxLength

Short description

No more than this many characters

Definition

The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-10

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: N/A - MIF rather than RIM level

answerValueSet

S C

0..1

Element id

Questionnaire.item.item.item.answerValueSet

Short description

Valueset containing permitted answers

Definition

A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.

Comments

LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-4, que-5

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
Auswahl aus EBM-Ziffern

https://fhir.bfarm.de/ValueSet/HealthAppEbm

Auswahl aus ICD-Codes

https://fhir.bfarm.de/ValueSet/HealthAppIcd

Auswahl aus Ländern

http://hl7.org/fhir/ValueSet/iso3166-1-2

Auswahl aus Sprachen

http://hl7.org/fhir/ValueSet/all-languages

Mappings

rim: N/A - MIF rather than RIM level

answerOption

S C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.answerOption

Short description

Permitted answer

Definition

One of the permitted answers for a "choice" or "open-choice" question.

Comments

This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-4, que-5

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.answerOption.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

Questionnaire.item.item.item.answerOption.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaireAnswerOptionDescription

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

description

S C

0..1

Extension(Complex)

Element id

Questionnaire.item.item.item.answerOption.extension:description

Short description

Beschreibungstexte

Alternate names

extensions, user content

Definition

Zusätzliche Beschreibungstexte der AnswerOption.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.answerOption.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.answerOption.value[x]

Short description

Answer value

Definition

A potential answer that's allowed as the answer to this question.

Comments

The data type of the value must agree with the item.type.

Binding

Allowed values to answer questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

valueString

Data type

initialSelected

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.answerOption.initialSelected

Short description

Whether option is selected by default

Definition

Indicates whether the answer value is selected when the list of possible answers is initially shown.

Comments

Use this instead of initial[v] if answerValueSet is present.

Meaning when missing

Only selected items explicitly marked to be selected

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

initial

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.initial

Short description

Initial value(s) when item is first rendered

Definition

One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.

Requirements

In some workflows, having defaults saves time.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: que-8, que-13

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

0..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.initial.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.initial.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.initial.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.initial.value[x]

Short description

Actual value for initializing the question

Definition

The actual value to for an initial answer.

Comments

The type of the initial value must be consistent with the type of the item.

Binding

Allowed values to answer questions.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A - MIF rather than RIM level

valueBoolean

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

item

0..*

see (item)

There are no (further) constraints on this element

Element id

Questionnaire.item.item.item.item

Short description

Nested questionnaire items

Definition

Text, questions and other groups to be nested beneath a question or group.

Requirements

Reports can consist of complex nested groups.

Comments

There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.

Conditions

The cardinality or value of this element may be affected by these constraints: que-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=COMP].target

HealthAppQuestionnaireResponse

Das Profil HealthAppQuestionnaireResponse (QuestionnaireResponse) repräsentiert den Antwortdatensatz zu einem DiGA-Fragenkatalog aus dem elektronischen Antragsportal.

HealthAppQuestionnaireResponse (QuestionnaireResponse)

S C

QuestionnaireResponse

Element id

QuestionnaireResponse

Short description

Antworten eines Fragenkatalogs

Alternate names

Form, QuestionnaireAnswers

Definition

In diesem Profil werden die vom Hersteller gegebenen Antworten für einen bestimmten Fragenkatalog repräsentiert.

Comments

The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.

Data type

QuestionnaireResponse

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act
workflow: Event
rim: Observation[moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

QuestionnaireResponse.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

text

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.identifier

Short description

Unique id for this set of answers

Definition

A business identifier assigned to a particular completed (or partially completed) questionnaire.

Requirements

Used for tracking, registration and other business purposes.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.identifier
w5: FiveWs.identifier
rim: .id

basedOn

0..*

Reference(CarePlan | ServiceRequest)

There are no (further) constraints on this element

Element id

QuestionnaireResponse.basedOn

Short description

Request fulfilled by this QuestionnaireResponse

Alternate names

order

Definition

The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

Requirements

Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon.

Data type

Reference(CarePlan | ServiceRequest)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.basedOn
rim: .outboundRelationship[typeCode=FLFS].target

partOf

0..*

Reference(Observation | Procedure)

There are no (further) constraints on this element

Element id

QuestionnaireResponse.partOf

Short description

Part of this action

Definition

A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.

Comments

Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn.

Data type

Reference(Observation | Procedure)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.partOf
rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]

questionnaire

S Σ

1..1

Element id

QuestionnaireResponse.questionnaire

Short description

Fragenkatalog

Alternate names

Form

Definition

Die URL zum beantworteten Fragenkatalog.

Requirements

Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form.

Comments

If a QuestionnaireResponse references a Questionnaire, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.instantiates
rim: ./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]

status

S Σ ?!

1..1

codeBinding

Element id

QuestionnaireResponse.status

Short description

Status (completed)

Definition

Der Status der Antworten des Fragenkatalogs. Dieser ist hier immer auf completed gesetzt.

Requirements

The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Data type

QuestionnaireResponseStatus (required)

Binding

Lifecycle status of the questionnaire response.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.status
w5: FiveWs.status
rim: .statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish "in-progress" from "published)

subject

S Σ

1..1

Reference(HealthApp)

Element id

QuestionnaireResponse.subject

Short description

HealthApp

Alternate names

Patient, Focus

Definition

Die Referenz zur digitalen Anwendung auf welche sich die Antworten beziehen (HealthApp).

Requirements

Allows linking the answers to the individual the answers describe. May also affect access control.

Comments

If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.

Data type

Reference(HealthApp)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.subject
w5: FiveWs.subject[x]
rim: .participation[typeCode=SBJ].role
w5: FiveWs.subject

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.subject.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.subject.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

reference

S Σ C

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.subject.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

QuestionnaireResponse.subject.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.subject.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .identifier

display

S Σ

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.subject.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

encounter

0..1

Reference(Encounter)

There are no (further) constraints on this element

Element id

QuestionnaireResponse.encounter

Short description

Encounter created as part of

Definition

The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

Requirements

Provides context for the information that was captured. May also affect access control.

Comments

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.

Data type

Reference(Encounter)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.encounter
w5: FiveWs.context
rim: .inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]

authored

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.authored

Short description

Date the answers were gathered

Alternate names

Date Created, Date published, Date Issued, Date updated

Definition

The date and/or time that this set of answers were last changed.

Requirements

Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.

Comments

May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured.

This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.occurrence[x]
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

author

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.author

Short description

Person who received and recorded the answers

Alternate names

Laboratory, Service, Practitioner, Department, Company, Performer

Definition

Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.

Requirements

Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.

Comments

Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

workflow: Event.performer
w5: FiveWs.author
rim: .participation[typeCode=AUT].role

source

0..1

Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)

There are no (further) constraints on this element

Element id

QuestionnaireResponse.source

Short description

The person who answered the questions

Definition

The person who answered the questions about the subject.

Requirements

When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions.

Comments

If not specified, no inference can be made about who provided the data.

Data type

Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

w5: FiveWs.source
rim: .participation[typeCode=INF].role

item

S C

0..*

Element id

QuestionnaireResponse.item

Short description

Assessments

Definition

Die erste Ebene des Fragenkatalogs.

Comments

Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qrs-1: Nested item can't be beneath both item and answer
(answer.exists() and item.exists()).not()

Mappings

rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

linkId

1..1

Element id

QuestionnaireResponse.item.linkId

Short description

Assessment-ID

Definition

Die eindeutige ID des Assessments.

Requirements

Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id

definition

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.definition

Short description

ElementDefinition - details for the item

Definition

A reference to an ElementDefinition that provides the details for the item.

Requirements

A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition.

Comments

The ElementDefinition must be in a StructureDefinition, and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x].

There is no need for this element if the item pointed to by the linkId has a definition listed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code

text

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.text

Short description

Name for group or question text

Definition

Text that is displayed above the contents of the group or as the text of the question being answered.

Requirements

Allows the questionnaire response to be read without access to the questionnaire.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .text

answer

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.answer

Short description

The response(s) to the question

Definition

The respondent's answer(s) to the question.

Comments

The value is nested because we cannot have a repeating structure that has variable type.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .value[type=LIST_ANY]

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.answer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.answer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.answer.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.answer.value[x]

Short description

Single-valued answer to the question

Definition

The answer (or one of the answers) provided by the respondent to the question.

Requirements

Ability to retain a single-valued answer to a question.

Comments

More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.

Binding

Code indicating the response provided for a question.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .item

valueBoolean

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

item

0..*

see (item)

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.answer.item

Short description

Nested groups and questions

Definition

Nested groups and/or questions found within this particular answer.

Requirements

It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

item

0..*

see (item)

Element id

QuestionnaireResponse.item.item

Short description

Questionblocks

Definition

Die zweite Ebene des Fragenkatalogs.

Requirements

Reports can consist of complex nested groups.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

linkId

1..1

Element id

QuestionnaireResponse.item.item.linkId

Short description

Questionblock-ID

Definition

Die eindeutige ID des Questionblocks.

Requirements

Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id

definition

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.definition

Short description

ElementDefinition - details for the item

Definition

A reference to an ElementDefinition that provides the details for the item.

Requirements

Comments

There is no need for this element if the item pointed to by the linkId has a definition listed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code

text

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.text

Short description

Name for group or question text

Definition

Text that is displayed above the contents of the group or as the text of the question being answered.

Requirements

Allows the questionnaire response to be read without access to the questionnaire.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .text

answer

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.answer

Short description

The response(s) to the question

Definition

The respondent's answer(s) to the question.

Comments

The value is nested because we cannot have a repeating structure that has variable type.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .value[type=LIST_ANY]

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.answer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.answer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.answer.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.answer.value[x]

Short description

Single-valued answer to the question

Definition

The answer (or one of the answers) provided by the respondent to the question.

Requirements

Ability to retain a single-valued answer to a question.

Comments

Binding

Code indicating the response provided for a question.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .item

valueBoolean

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

item

0..*

see (item)

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.answer.item

Short description

Nested groups and questions

Definition

Nested groups and/or questions found within this particular answer.

Requirements

It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

item

0..*

see (item)

Element id

QuestionnaireResponse.item.item.item

Short description

Questions

Definition

Die dritte Ebene des Fragenkatalogs.

Requirements

Reports can consist of complex nested groups.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.item.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

QuestionnaireResponse.item.item.item.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaireResponseItemInapplicable

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

inapplicable

S C

0..1

Extension(Complex)

Element id

QuestionnaireResponse.item.item.item.extension:inapplicable

Short description

Trifft nicht zu

Alternate names

extensions, user content

Definition

Gibt an ob "Trifft nicht zu" ausgewählt wurde, sofern dies für die entsprechende Frage möglich ist.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.item.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

linkId

1..1

Element id

QuestionnaireResponse.item.item.item.linkId

Short description

Question-ID

Definition

Die eindeutige ID der Question.

Requirements

Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id

definition

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.item.definition

Short description

ElementDefinition - details for the item

Definition

A reference to an ElementDefinition that provides the details for the item.

Requirements

Comments

There is no need for this element if the item pointed to by the linkId has a definition listed.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code

text

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.item.text

Short description

Name for group or question text

Definition

Text that is displayed above the contents of the group or as the text of the question being answered.

Requirements

Allows the questionnaire response to be read without access to the questionnaire.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .text

answer

0..*

Element id

QuestionnaireResponse.item.item.item.answer

Short description

Antwort

Definition

Eine gegebene Antwort zur Question.

Comments

The value is nested because we cannot have a repeating structure that has variable type.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: .value[type=LIST_ANY]

0..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.item.answer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

Element id

QuestionnaireResponse.item.item.item.answer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://fhir.bfarm.de/StructureDefinition/HealthAppQuestionnaireResponseAnswerRange

Slicing

Unordered, Open, by url(Value)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

range

S C

0..1

Extension(Range)

Element id

QuestionnaireResponse.item.item.item.answer.extension:range

Short description

Beschreibungstexte

Alternate names

extensions, user content

Definition

Zusätzliche Beschreibungstexte des Items.

Comments

Data type

Extension(Range)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.item.answer.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

QuestionnaireResponse.item.item.item.answer.value[x]

Short description

Single-valued answer to the question

Definition

The answer (or one of the answers) provided by the respondent to the question.

Requirements

Ability to retain a single-valued answer to a question.

Comments

Binding

Code indicating the response provided for a question.