Point-of-Care Device Implementation Guide
0.4.0 - CI Build International flag

Point-of-Care Device Implementation Guide, published by HL7 International / Devices. This guide is not an authorized publication; it is the continuous build for version 0.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/uv-pocd/ and changes regularly. See the Directory of published versions

Extension: Relation extension

Official URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/relation Version: 0.4.0
Standards status: Draft Maturity Level: 2 Computable Name: Relation

Relation allows the modelling of relationships between a metric and other containment tree entries. Related containment tree entries are defined in Entries, whereby the flavor of a relationship can be set up in Kind.

Context of Use

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Modelling relationships
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kind 1..1 Extension Kind of relation
..... url 1..1 uri "kind"
..... valueCode 1..1 code Value of extension
Binding: Kind (required): Kind of relationship
.... extension:entries 1..* Extension Referenced containment tree entries
..... url 1..1 uri "entries"
..... valueReference 1..1 Reference() Value of extension
...... reference 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier 0..1 Identifier Logical reference, when literal reference is not known
....... system 0..1 uri The namespace for the identifier value
....... value 0..1 string The value that is unique
.... extension:code 0..1 Extension Description of relation
..... url 1..1 uri "code"
..... valueCoding 1..1 Coding Value of extension
...... system 0..1 uri Identity of the terminology system
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
... url 1..1 uri "http://hl7.org/fhir/uv/pocd/StructureDefinition/relation"
... value[x] 0..0 Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Modelling relationships
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kind 1..1 Extension Kind of relation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "kind"
..... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCode 1..1 code Value of extension
Binding: Kind (required): Kind of relationship
.... extension:entries 1..* Extension Referenced containment tree entries
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "entries"
..... Slices for value[x] 1..1 Reference() Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference 1..1 Reference() Value of extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
....... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value Σ 0..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... display Σ 0..1 string Text alternative for the resource
.... extension:code 0..1 Extension Description of relation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "code"
..... Slices for value[x] 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCoding 1..1 Coding Value of extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... url 1..1 uri "http://hl7.org/fhir/uv/pocd/StructureDefinition/relation"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Relation allows the modelling of relationships between a metric and other containment tree entries. Related containment tree entries are defined in Entries, whereby the flavor of a relationship can be set up in Kind.

  • kind: code: Kind specifies the relationship between the metric and referenced containment tree entries.
  • entries: Reference: List of references that relate to the metric.
  • code: Coding: Code allows the semantic description of the relationship between the metric and the list of related containment tree entries defined in Entries.

Maturity: 2

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Modelling relationships
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kind 1..1 Extension Kind of relation
..... url 1..1 uri "kind"
..... valueCode 1..1 code Value of extension
Binding: Kind (required): Kind of relationship
.... extension:entries 1..* Extension Referenced containment tree entries
..... url 1..1 uri "entries"
..... valueReference 1..1 Reference() Value of extension
...... reference 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier 0..1 Identifier Logical reference, when literal reference is not known
....... system 0..1 uri The namespace for the identifier value
....... value 0..1 string The value that is unique
.... extension:code 0..1 Extension Description of relation
..... url 1..1 uri "code"
..... valueCoding 1..1 Coding Value of extension
...... system 0..1 uri Identity of the terminology system
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
... url 1..1 uri "http://hl7.org/fhir/uv/pocd/StructureDefinition/relation"
... value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Modelling relationships
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kind 1..1 Extension Kind of relation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "kind"
..... Slices for value[x] 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCode 1..1 code Value of extension
Binding: Kind (required): Kind of relationship
.... extension:entries 1..* Extension Referenced containment tree entries
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "entries"
..... Slices for value[x] 1..1 Reference() Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference 1..1 Reference() Value of extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
....... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
........ value Σ 0..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... display Σ 0..1 string Text alternative for the resource
.... extension:code 0..1 Extension Description of relation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "code"
..... Slices for value[x] 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCoding 1..1 Coding Value of extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... url 1..1 uri "http://hl7.org/fhir/uv/pocd/StructureDefinition/relation"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Relation allows the modelling of relationships between a metric and other containment tree entries. Related containment tree entries are defined in Entries, whereby the flavor of a relationship can be set up in Kind.

  • kind: code: Kind specifies the relationship between the metric and referenced containment tree entries.
  • entries: Reference: List of references that relate to the metric.
  • code: Coding: Code allows the semantic description of the relationship between the metric and the list of related containment tree entries defined in Entries.

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:kind.​value[x]:valueCode Base required Kind 📦0.4.0 This IG
Extension.extension:entries.​value[x]:valueReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Extension.extension:entries.​value[x]:valueReference.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Extension.extension:entries.​value[x]:valueReference.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()