CARECONNECT-BASE\NHSCommunication-1

INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build

INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

Extension: Extension-CareConnect-NHSCommunication-1

This extension is constrained to support the communication preferences for a resource in the NHS.

The official URL for this extension is:

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1

Status: draft
Extension maintained by: INTEROpen

Context of Use

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

{"type"=>"Patient"}
{"type"=>"Practitioner"}

Usage info

Usage:

Use this Extension: CareConnect-Patient-1, CareConnect-Practitioner-1

Formal Views of Extension Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from Extension

Summary

Mandatory: 2 elements (4 nested mandatory elements)
Fixed Value: 6 elements
Prohibited: 1 element

This structure is derived from Extension

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	NHS communication preferences for a resource
extension	0..*	Extension	Slice: Unordered, Open by value:url
extension:language	1..1	Extension	Languages which may be used for communication
url	1..1	uri	"language"
valueCodeableConcept:valueCodeableConcept	1..1	CodeableConcept	Languages which may be used for communication Binding: Care Connect Human Language (required)
extension:preferred	0..1	Extension	Language preference indicator
url	1..1	uri	"preferred"
valueBoolean	1..1	boolean	Indicates whether or not this language is preferred (over other languages up a certain level)
extension:modeOfCommunication	0..*	Extension	Mode of communication for the selected language
url	1..1	uri	"modeOfCommunication"
valueCodeableConcept:valueCodeableConcept	1..1	CodeableConcept	A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. Binding: Care Connect Language Ability Mode (required)
extension:communicationProficiency	0..1	Extension	The level of proficiency in communicating a language
url	1..1	uri	"communicationProficiency"
valueCodeableConcept:valueCodeableConcept	1..1	CodeableConcept	A valueset to describe the level of proficiency in communicating a language Binding: Care Connect Language Ability Proficiency (required)
extension:interpreterRequired	0..1	Extension	Interpreter preference indicator
url	1..1	uri	"interpreterRequired"
valueBoolean	1..1	boolean	Indicates whether an interpreter is required for communication purposes
url	1..1	uri	"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1"
value[x]	0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..*	Extension	NHS communication preferences for a resource
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:language		1..1	Extension	Languages which may be used for communication
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"language"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Languages which may be used for communication Binding: Care Connect Human Language (required)
extension:preferred		0..1	Extension	Language preference indicator
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"preferred"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean		1..1	boolean	Indicates whether or not this language is preferred (over other languages up a certain level)
extension:modeOfCommunication		0..*	Extension	Mode of communication for the selected language
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"modeOfCommunication"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. Binding: Care Connect Language Ability Mode (required)
extension:communicationProficiency		0..1	Extension	The level of proficiency in communicating a language
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"communicationProficiency"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	A valueset to describe the level of proficiency in communicating a language Binding: Care Connect Language Ability Proficiency (required)
extension:interpreterRequired		0..1	Extension	Interpreter preference indicator
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"interpreterRequired"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean		1..1	boolean	Indicates whether an interpreter is required for communication purposes
url		1..1	uri	"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1"
Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements (4 nested mandatory elements)
Fixed Value: 6 elements
Prohibited: 1 element

Differential View

This structure is derived from Extension

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	NHS communication preferences for a resource
extension	0..*	Extension	Slice: Unordered, Open by value:url
extension:language	1..1	Extension	Languages which may be used for communication
url	1..1	uri	"language"
valueCodeableConcept:valueCodeableConcept	1..1	CodeableConcept	Languages which may be used for communication Binding: Care Connect Human Language (required)
extension:preferred	0..1	Extension	Language preference indicator
url	1..1	uri	"preferred"
valueBoolean	1..1	boolean	Indicates whether or not this language is preferred (over other languages up a certain level)
extension:modeOfCommunication	0..*	Extension	Mode of communication for the selected language
url	1..1	uri	"modeOfCommunication"
valueCodeableConcept:valueCodeableConcept	1..1	CodeableConcept	A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. Binding: Care Connect Language Ability Mode (required)
extension:communicationProficiency	0..1	Extension	The level of proficiency in communicating a language
url	1..1	uri	"communicationProficiency"
valueCodeableConcept:valueCodeableConcept	1..1	CodeableConcept	A valueset to describe the level of proficiency in communicating a language Binding: Care Connect Language Ability Proficiency (required)
extension:interpreterRequired	0..1	Extension	Interpreter preference indicator
url	1..1	uri	"interpreterRequired"
valueBoolean	1..1	boolean	Indicates whether an interpreter is required for communication purposes
url	1..1	uri	"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1"
value[x]	0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..*	Extension	NHS communication preferences for a resource
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:language		1..1	Extension	Languages which may be used for communication
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"language"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Languages which may be used for communication Binding: Care Connect Human Language (required)
extension:preferred		0..1	Extension	Language preference indicator
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"preferred"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean		1..1	boolean	Indicates whether or not this language is preferred (over other languages up a certain level)
extension:modeOfCommunication		0..*	Extension	Mode of communication for the selected language
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"modeOfCommunication"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. Binding: Care Connect Language Ability Mode (required)
extension:communicationProficiency		0..1	Extension	The level of proficiency in communicating a language
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"communicationProficiency"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	A valueset to describe the level of proficiency in communicating a language Binding: Care Connect Language Ability Proficiency (required)
extension:interpreterRequired		0..1	Extension	Interpreter preference indicator
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"interpreterRequired"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean		1..1	boolean	Indicates whether an interpreter is required for communication purposes
url		1..1	uri	"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1"
Documentation for this format

Other representations of extension: Schematron

Terminology Bindings

Path	Conformance	ValueSet
Extension.extension:language.value[x]:valueCodeableConcept	required	Care Connect Human Language
Extension.extension:modeOfCommunication.value[x]:valueCodeableConcept	required	Care Connect Language Ability Mode
Extension.extension:communicationProficiency.value[x]:valueCodeableConcept	required	Care Connect Language Ability Proficiency

Constraints

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

IG © 2020+ INTEROpen. Package careconnect.base.stu3#3.0.0 based on FHIR 3.0.2. Generated 2020-03-10
Links: Table of Contents | QA Report