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

Point-of-Care Device Implementation Guide, published by HL7 International - Devices Work Group. This is not an authorized publication; it is the continuous build for version current). 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: current
Draft as of 2022-01-16 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):

  • Element ID DeviceMetric

Usage info

Usage:

Formal Views of Extension Content

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

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.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionModelling relationships
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:kind 1..1ExtensionKind of relation
.... url 1..1uri"kind"
.... valueCode 1..1codeValue of extension
Binding: Kind (required): Kind of relationship

... extension:entries 1..*ExtensionReferenced containment tree entries
.... url 1..1uri"entries"
.... valueReference 1..1Reference()Value of extension
..... reference 0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier 0..1IdentifierLogical reference, when literal reference is not known
...... system 0..1uriThe namespace for the identifier value
...... value 0..1stringThe value that is unique
.... url 1..1uri"code"
.... valueCoding 1..1CodingValue of extension
..... system 0..1uriIdentity of the terminology system
..... version 0..1stringVersion of the system - if relevant
..... code 0..1codeSymbol in syntax defined by the system
... url 1..1uri"http://hl7.org/fhir/uv/pocd/StructureDefinition/relation"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionModelling relationships
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:kind 1..1ExtensionKind of relation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"kind"
.... Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCode 1..1codeValue of extension
Binding: Kind (required): Kind of relationship

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"entries"
.... Slices for value[x] 1..1Reference()Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference 1..1Reference()Value of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ0..1stringThe value that is unique
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display Σ0..1stringText alternative for the resource
... extension:code 0..1ExtensionDescription of relation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"code"
.... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCoding 1..1CodingValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... url 1..1uri"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.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionModelling relationships
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:kind 1..1ExtensionKind of relation
.... url 1..1uri"kind"
.... valueCode 1..1codeValue of extension
Binding: Kind (required): Kind of relationship

... extension:entries 1..*ExtensionReferenced containment tree entries
.... url 1..1uri"entries"
.... valueReference 1..1Reference()Value of extension
..... reference 0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier 0..1IdentifierLogical reference, when literal reference is not known
...... system 0..1uriThe namespace for the identifier value
...... value 0..1stringThe value that is unique
.... url 1..1uri"code"
.... valueCoding 1..1CodingValue of extension
..... system 0..1uriIdentity of the terminology system
..... version 0..1stringVersion of the system - if relevant
..... code 0..1codeSymbol in syntax defined by the system
... url 1..1uri"http://hl7.org/fhir/uv/pocd/StructureDefinition/relation"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionModelling relationships
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:kind 1..1ExtensionKind of relation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"kind"
.... Slices for value[x] 1..1codeValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCode 1..1codeValue of extension
Binding: Kind (required): Kind of relationship

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"entries"
.... Slices for value[x] 1..1Reference()Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference 1..1Reference()Value of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ0..1stringThe value that is unique
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display Σ0..1stringText alternative for the resource
... extension:code 0..1ExtensionDescription of relation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"code"
.... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCoding 1..1CodingValue of extension
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... url 1..1uri"http://hl7.org/fhir/uv/pocd/StructureDefinition/relation"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:kind.value[x]:valueCoderequiredKind
Extension.extension:entries.value[x]:valueReference.typeextensibleResourceType
Extension.extension:entries.value[x]:valueReference.identifier.userequiredIdentifierUse
Extension.extension:entries.value[x]:valueReference.identifier.typeextensibleIdentifier Type Codes