FHIR Clinical Documents
1.0.0 - STU 1 International flag

This page is part of the FHIR Clinical Documents (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: Informant Extension

Official URL: http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/informant-extension Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: InformantExtension

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Informant Extension describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.

Context of Use

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

Usage info

Usages:

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 Informant Extension
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:type 1..* Extension Meaning and purpose of participation, in creation of the clinical document. The list includes: data entry person, informant, primary information recipient, and tracker. Other types are allowed.
..... extension 0..0
..... url 1..1 uri "type"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: INF
........ display 1..1 string Representation defined by the system
Fixed Value: informant
.... extension:function 0..* Extension Exact function of the participant in the creation of the clinical document. This is more granular than type.
..... extension 0..0
..... url 1..1 uri "function"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ParticipationFunction (extensible)
.... extension:time 0..1 Extension Time period of participation
..... extension 0..0
..... url 1..1 uri "time"
..... value[x] 1..1 Period Value of extension
.... extension:party S 1..1 Extension participant
..... extension 0..0
..... url 1..1 uri "party"
..... value[x] 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization) Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/informant-extension"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Informant Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 1..* Extension Meaning and purpose of participation, in creation of the clinical document. The list includes: data entry person, informant, primary information recipient, and tracker. Other types are allowed.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "type"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: INF
........ display 1..1 string Representation defined by the system
Fixed Value: informant
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
.... extension:function 0..* Extension Exact function of the participant in the creation of the clinical document. This is more granular than type.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "function"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ParticipationFunction (extensible)
.... extension:time 0..1 Extension Time period of participation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "time"
..... value[x] 1..1 Period Value of extension
.... extension:party S 1..1 Extension participant
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "party"
..... value[x] 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization) Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/informant-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Informant Extension describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.

  • type: CodeableConcept: An Extension
  • function: CodeableConcept: An Extension
  • time: Period: An Extension
  • party: Reference: An Extension

Maturity: 2

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Informant Extension
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:type 1..* Extension Meaning and purpose of participation, in creation of the clinical document. The list includes: data entry person, informant, primary information recipient, and tracker. Other types are allowed.
..... extension 0..0
..... url 1..1 uri "type"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: INF
........ display 1..1 string Representation defined by the system
Fixed Value: informant
.... extension:function 0..* Extension Exact function of the participant in the creation of the clinical document. This is more granular than type.
..... extension 0..0
..... url 1..1 uri "function"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ParticipationFunction (extensible)
.... extension:time 0..1 Extension Time period of participation
..... extension 0..0
..... url 1..1 uri "time"
..... value[x] 1..1 Period Value of extension
.... extension:party S 1..1 Extension participant
..... extension 0..0
..... url 1..1 uri "party"
..... value[x] 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization) Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/informant-extension"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Informant Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type 1..* Extension Meaning and purpose of participation, in creation of the clinical document. The list includes: data entry person, informant, primary information recipient, and tracker. Other types are allowed.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "type"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: INF
........ display 1..1 string Representation defined by the system
Fixed Value: informant
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
.... extension:function 0..* Extension Exact function of the participant in the creation of the clinical document. This is more granular than type.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "function"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ParticipationFunction (extensible)
.... extension:time 0..1 Extension Time period of participation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "time"
..... value[x] 1..1 Period Value of extension
.... extension:party S 1..1 Extension participant
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "party"
..... value[x] 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization) Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/informant-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Informant Extension describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.

  • type: CodeableConcept: An Extension
  • function: CodeableConcept: An Extension
  • time: Period: An Extension
  • party: Reference: An Extension

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:function.value[x]extensibleParticipationFunction
http://terminology.hl7.org/ValueSet/v3-ParticipationFunction

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()