GP Connect - Update Record (ITK3)

A newer version of this specification is available (v1.1.1-public-beta).
An issue was identified with the FHIR package supplied with this version of the specification, which has been rectified.
Please click here to view the patched v1.1.1-public-beta specification with the updated FHIR package.

Extension: Extension-ITK-MessageHandling-2

Profile
Dictionary

Extension	I		Extension	Element Id Extension Short description An extension to support ITK message handling Definition Optional Extension Element - found in all resources. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
extension	I	0..*	Extension	Element Id Extension.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. In order 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. 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 Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
BusAckRequested	I	1..1	Extension	Element Id Extension.extension:BusAckRequested Short description Populated when sender requires a business level response to be returned. Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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. 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Element Id Extension.extension:BusAckRequested.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 uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value BusAckRequested Mappings rim:n/a rim:N/A
valueBoolean		1..1	boolean	Element Id Extension.extension:BusAckRequested.valueBoolean:valueBoolean Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
InfAckRequested	I	1..1	Extension	Element Id Extension.extension:InfAckRequested Short description Populated when sender requires an infrastructure level response to be returned. Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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. 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Element Id Extension.extension:InfAckRequested.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 uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value InfAckRequested Mappings rim:n/a rim:N/A
valueBoolean		1..1	boolean	Element Id Extension.extension:InfAckRequested.valueBoolean:valueBoolean Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
RecipientType	I	1..1	Extension	Element Id Extension.extension:RecipientType Short description Indicates the type of recipient. Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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. 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Element Id Extension.extension:RecipientType.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 uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value RecipientType Mappings rim:n/a rim:N/A
valueCoding		1..1	CodingBinding	Element Id Extension.extension:RecipientType.valueCoding:valueCoding Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Data Type Coding Binding A set of codes to describe if the recipient has been sent the payload for action or for information. ITK Recipient Type (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
system	Σ	1..1	uriFixed Value	Element Id Extension.extension:RecipientType.valueCoding:valueCoding.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 de-reference to some definition that establish the system clearly and unambiguously. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value https://fhir.nhs.uk/STU3/CodeSystem/ITK-RecipientType-1 Mappings rim:n/a v2:CE.3 rim:./codeSystem orim:*fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..0	string	There are no (further) constraints on this element Element Id Extension.extension:RecipientType.valueCoding:valueCoding.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 string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE.7 rim:./codeSystemVersion orim:*fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	1..1	code	There are no (further) constraints on this element Element Id Extension.extension:RecipientType.valueCoding:valueCoding.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. Comments Note that FHIR strings may not exceed 1MB in size Data Type code Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE.1 rim:./code orim:*fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	1..1	string	There are no (further) constraints on this element Element Id Extension.extension:RecipientType.valueCoding:valueCoding.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. Comments Note that FHIR strings may not exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE.2 - but note this is not well followed rim:CV.displayName orim:*fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..0	boolean	There are no (further) constraints on this element Element Id Extension.extension:RecipientType.valueCoding:valueCoding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - i.e. 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 boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a 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 ]
MessageDefinition	I	1..1	Extension	Element Id Extension.extension:MessageDefinition Short description A reference to a URL for the MessageDefinition for the payload, which can be any message definition instance which conforms to the ITK message definition profile. This MessageDefinition will detail the information to allow correct processing of the payload, such as profiles used, message event type, profiles used, responses allowed/ required etc.. Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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. 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Element Id Extension.extension:MessageDefinition.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 uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value MessageDefinition Mappings rim:n/a rim:N/A
valueReference		1..1	Reference()	Element Id Extension.extension:MessageDefinition.valueReference:valueReference Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Data Type Reference() Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
reference	Σ I	1..1	string	There are no (further) constraints on this element Element Id Extension.extension:MessageDefinition.valueReference:valueReference.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 string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..0	Identifier	There are no (further) constraints on this element Element Id Extension.extension:MessageDefinition.valueReference:valueReference.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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 rim:.identifier
display	Σ	0..0	string	There are no (further) constraints on this element Element Id Extension.extension:MessageDefinition.valueReference:valueReference.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 string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
SenderReference	I	1..1	Extension	Element Id Extension.extension:SenderReference Short description A reference that the sender includes and wants returned in any response. Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. In order 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. 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Element Id Extension.extension:SenderReference.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 uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value SenderReference Mappings rim:n/a rim:N/A
valueString		1..1	string	Element Id Extension.extension:SenderReference.valueString:valueString Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Maximum string length 255 Mappings rim:n/a rim:N/A
LocalExtension	I	1..1	Extension	There are no (further) constraints on this element Element Id Extension.extension:LocalExtension 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. In order 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. 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Element Id Extension.extension:LocalExtension.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 uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value LocalExtension Mappings rim:n/a rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Extension.extension:LocalExtension.value[x] Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueBase64Binary			base64Binary	There are no (further) constraints on this element Data Type base64Binary
valueBoolean			boolean	There are no (further) constraints on this element Data Type boolean
valueCode			code	There are no (further) constraints on this element Data Type code
valueDate			date	There are no (further) constraints on this element Data Type date
valueDateTime			dateTime	There are no (further) constraints on this element Data Type dateTime
valueDecimal			decimal	There are no (further) constraints on this element Data Type decimal
valueId			id	There are no (further) constraints on this element Data Type id
valueInstant			instant	There are no (further) constraints on this element Data Type instant
valueInteger			integer	There are no (further) constraints on this element Data Type integer
valueMarkdown			markdown	There are no (further) constraints on this element Data Type markdown
valueOid			oid	There are no (further) constraints on this element Data Type oid
valuePositiveInt			positiveInt	There are no (further) constraints on this element Data Type positiveInt
valueString			string	There are no (further) constraints on this element Data Type string
valueTime			time	There are no (further) constraints on this element Data Type time
valueUnsignedInt			unsignedInt	There are no (further) constraints on this element Data Type unsignedInt
valueUri			uri	There are no (further) constraints on this element Data Type uri
valueAddress			Address	There are no (further) constraints on this element Data Type Address
valueAge			Age	There are no (further) constraints on this element Data Type Age
valueAnnotation			Annotation	There are no (further) constraints on this element Data Type Annotation
valueAttachment			Attachment	There are no (further) constraints on this element Data Type Attachment
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
valueCoding			Coding	There are no (further) constraints on this element Data Type Coding
valueContactPoint			ContactPoint	There are no (further) constraints on this element Data Type ContactPoint
valueCount			Count	There are no (further) constraints on this element Data Type Count
valueDistance			Distance	There are no (further) constraints on this element Data Type Distance
valueDuration			Duration	There are no (further) constraints on this element Data Type Duration
valueHumanName			HumanName	There are no (further) constraints on this element Data Type HumanName
valueIdentifier			Identifier	There are no (further) constraints on this element Data Type Identifier
valueMoney			Money	There are no (further) constraints on this element Data Type Money
valuePeriod			Period	There are no (further) constraints on this element Data Type Period
valueQuantity			Quantity	There are no (further) constraints on this element Data Type Quantity
valueRange			Range	There are no (further) constraints on this element Data Type Range
valueRatio			Ratio	There are no (further) constraints on this element Data Type Ratio
valueSampledData			SampledData	There are no (further) constraints on this element Data Type SampledData
valueSignature			Signature	There are no (further) constraints on this element Data Type Signature
valueTiming			Timing	There are no (further) constraints on this element Data Type Timing
valueMeta			Meta	There are no (further) constraints on this element Data Type Meta
valueReference			Reference()	There are no (further) constraints on this element Data Type Reference()
url		1..1	uriFixed Value	Element Id Extension.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 uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ITK-MessageHandling-2 Mappings rim:n/a rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Extension.value[x] Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A

Extension
Definition	Optional Extension Element - found in all resources.
Cardinality	0...*
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a
Extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:BusAckRequested
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	1...1
Type	Extension
Alias	extensions, user content
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:BusAckRequested.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a
Extension.extension:BusAckRequested.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:BusAckRequested.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Fixed Value	BusAckRequested
Mappings	rim:n/a rim:N/A
Extension.extension:BusAckRequested.valueBoolean:valueBoolean
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality	1...1
Type	boolean
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.extension:InfAckRequested
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	1...1
Type	Extension
Alias	extensions, user content
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:InfAckRequested.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a
Extension.extension:InfAckRequested.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:InfAckRequested.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Fixed Value	InfAckRequested
Mappings	rim:n/a rim:N/A
Extension.extension:InfAckRequested.valueBoolean:valueBoolean
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality	1...1
Type	boolean
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.extension:RecipientType
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	1...1
Type	Extension
Alias	extensions, user content
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:RecipientType.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a
Extension.extension:RecipientType.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:RecipientType.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Fixed Value	RecipientType
Mappings	rim:n/a rim:N/A
Extension.extension:RecipientType.valueCoding:valueCoding
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality	1...1
Type	Coding
Binding	A set of codes to describe if the recipient has been sent the payload for action or for information. ITK Recipient Type (required)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.extension:RecipientType.value[x]:valueCoding.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a
Extension.extension:RecipientType.value[x]:valueCoding.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:RecipientType.valueCoding:valueCoding.system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	1...1
Type	uri
Summary	True
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 de-reference to some definition that establish the system clearly and unambiguously.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Fixed Value	https://fhir.nhs.uk/STU3/CodeSystem/ITK-RecipientType-1
Mappings	rim:n/a v2:CE.3 rim:./codeSystem orim:*fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Extension.extension:RecipientType.valueCoding:valueCoding.version
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.
Cardinality	0...0
Type	string
Summary	True
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a v2:CE.7 rim:./codeSystemVersion orim:*fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Extension.extension:RecipientType.valueCoding:valueCoding.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).
Cardinality	1...1
Type	code
Summary	True
Requirements	Need to refer to a particular code in the system.
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a v2:CE.1 rim:./code orim:*fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Extension.extension:RecipientType.valueCoding:valueCoding.display
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	1...1
Type	string
Summary	True
Requirements	Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a v2:CE.2 - but note this is not well followed rim:CV.displayName orim:*fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Extension.extension:RecipientType.valueCoding:valueCoding.userSelected
Definition	Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Cardinality	0...0
Type	boolean
Summary	True
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a 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 ]
Extension.extension:MessageDefinition
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	1...1
Type	Extension
Alias	extensions, user content
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:MessageDefinition.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a
Extension.extension:MessageDefinition.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:MessageDefinition.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Fixed Value	MessageDefinition
Mappings	rim:n/a rim:N/A
Extension.extension:MessageDefinition.valueReference:valueReference
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality	1...1
Type	Reference()
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.extension:MessageDefinition.value[x]:valueReference.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a
Extension.extension:MessageDefinition.value[x]:valueReference.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:MessageDefinition.valueReference:valueReference.reference
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.
Cardinality	1...1
Type	string
Summary	True
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.extension:MessageDefinition.valueReference:valueReference.identifier
Definition	An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.
Cardinality	0...0
Type	Identifier
Summary	True
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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 rim:.identifier
Extension.extension:MessageDefinition.valueReference:valueReference.display
Definition	Plain text narrative that identifies the resource in addition to the resource reference.
Cardinality	0...0
Type	string
Summary	True
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.extension:SenderReference
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	1...1
Type	Extension
Alias	extensions, user content
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:SenderReference.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a
Extension.extension:SenderReference.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:SenderReference.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Fixed Value	SenderReference
Mappings	rim:n/a rim:N/A
Extension.extension:SenderReference.valueString:valueString
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality	1...1
Type	string
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.extension:LocalExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	1...1
Type	Extension
Alias	extensions, user content
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:LocalExtension.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a
Extension.extension:LocalExtension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
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.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
Extension.extension:LocalExtension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Fixed Value	LocalExtension
Mappings	rim:n/a rim:N/A
Extension.extension:LocalExtension.value[x]
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality	1...1
Type	Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing, Meta
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a rim:N/A
Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
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.
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Fixed Value	https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ITK-MessageHandling-2
Mappings	rim:n/a rim:N/A
Extension.value[x]
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality	0...0
Type	Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing, Meta
Invariants	ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())`
Mappings	rim:n/a rim:N/A

Elements required for capability

Element	Use	CareConnect	UK Core
extension(BusAckRequested)
extension(InfAckRequested)
extension(RecipientType)
extension(MessageDefinition)
extension(SenderReference)
extension(LocalExtension)
url

id

Usage

Optional

Guidance

The id is the logical identifier for the `Extension-ITK-MessageHandling-2 extension.

Example

<id value="afad56d2-6004-40a0-8b85-c0566df0a257" />

extension(BusAckRequested)

Usage

Mandatory

Guidance

Senders

The BusAckRequested element MUST be set to fixed value of true.

This will request an ITK3 Response with a response code in the range 30001 to 30003.

ITK3 responses generated

The BusAckRequested element MUST contain a fixed value of false.

Example

<!-- Request Infrastructure ACK -->
<extension>
    <url value="BusAckRequested" />
    <valueBoolean value="true" />
</extension>

extension(InfAckRequested)

Usage

Mandatory

Guidance

Senders

The InfAckRequested element MUST be set to fixed value of true.

This will request an ITK3 Response with a response code in the range 10001 to 20013.

ITK3 responses generated

The InfAckRequested element MUST be set to fixed value of false.

Example

<!-- Request Infrastructure ACK -->
<extension>
    <url value="InfAckRequested" />
    <valueBoolean value="true" />
</extension>

extension(RecipientType)

Usage

Mandatory

Guidance

The RecipientType element MUST be set to a value taken from FHIR ValueSet ITK-RecipientType-1.

The meaning of RecipientType is applied in a common way across all ITK3 messaging.

FA ("For action") means the recipient has been sent the payload for action. The action required by the recipient will be either explicit in the payload or there will be a business rule defined. In this case, "FA" indicates that the recipient is expected to take the action of attaching the payload contents to the patient record.
FI ("For information") means that no action is required by the recipient and they may process the payload as they see fit.

Important: GP systems currently ignore the value in this element and as such, all messages are handled as "For action", regardless of which value is populated.

Example

<!-- For Action -->
<extension>
    <url value="RecipientType" />
    <valueCoding>
        <system value="https://fhir.nhs.uk/STU3/CodeSystem/ITK-RecipientType-1" />
        <code value="FA" />
        <display value="For Action" />
    </valueCoding>
</extension>

<!-- For Information -->
<extension>
    <url value="RecipientType" />
    <valueCoding>
        <system value="https://fhir.nhs.uk/STU3/CodeSystem/ITK-RecipientType-1" />
        <code value="FI" />
        <display value="For Information" />
    </valueCoding>
</extension>

extension(MessageDefinition)

Usage

Mandatory

Guidance

The NHS England Interoperability Standards (IOPS) team have not created a MessageDefinition for this specification. A reference value must be added in order to pass FHIR validation, thus the base message definition has been used.

Example

<extension>
    <url value="MessageDefinition" />
    <valueReference>
        <reference value="https://fhir.nhs.uk/MessageDefinition" />
    </valueReference>
</extension>

extension(SenderReference)

Usage

Mandatory

Guidance

Senders

The SenderReference element MUST be set to the unique identifier of the activity which has taken place at the sender organisation.

ITK3 responses generated

The SenderReference element MUST contain the same value as the sender provided.

Example

<!-- Sender Reference - unique identifier of activity -->
<extension>
    <url value="SenderReference" />
    <valueString value="846ebe66-5ff8-4499-bc57-a112d3d0daa3" />
</extension>

extension(LocalExtension)

Usage

Mandatory

Guidance

The LocalExtension element MUST be populated with None.

Example

<extension>
    <url value="LocalExtension" />
    <valueString value="None" />
</extension>

url

Usage

Mandatory

Guidance

The url element MUST be populated with a fixed value of https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ITK-MessageHandling-2.

Example

<extension>
    <url value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ITK-MessageHandling-2" />
</extension>

GP Connect - Update Record (ITK3)

Extension: Extension-ITK-MessageHandling-2

Related links

Elements required for capability

id

Usage

Guidance

Example

extension(BusAckRequested)

Usage

Guidance

Example

extension(InfAckRequested)

Usage

Guidance

Example

extension(RecipientType)

Usage

Guidance

Example

extension(MessageDefinition)

Usage

Guidance

Example

extension(SenderReference)

Usage

Guidance

Example

extension(LocalExtension)

Usage

Guidance

Example

url

Usage

Guidance

Example