NHS England Implementation Guide 1.2.0

StructureDefinition Extension-England-OrganisationRole

Canonical_URL	Description	Profile_Purpose
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole	An extension to describe the role of the organisation.	This extension extends the Organization resource to support the NHS England requirement for additional information about organisational roles.

Context of Use:

Organization, OrganizationAffiliation

Tree View

Extension	I		Extension	Element id Extension Short description An Extension to describe what an Organisation does. Definition Optional Extension Element - found in all resources. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	4..*	Extension	There are no (further) constraints on this element 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. 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 can 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) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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
instanceID	I	1..1	Extension	Element id Extension.extension:instanceID Short description Unique ID for each instance of an organisation role (organisation roles can be ended and then the organisation later undertakes same role again). Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can 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() or (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
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:instanceID.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:instanceID.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. 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 can 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) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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:instanceID.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 Fixed value instanceID Mappings rim: N/A
value[x]		1..1		There are no (further) constraints on this element Element id Extension.extension:instanceID.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
valueInteger			integer	Data type integer
roleCode	I	1..1	ExtensionBinding	Element id Extension.extension:roleCode 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. 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 can 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 Binding A ValueSet to identify the organisation role codes EnglandOrganisationRole (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:roleCode.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:roleCode.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. 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 can 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) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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:roleCode.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 Fixed value roleCode Mappings rim: N/A
value[x]		1..1		There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
valueCodeableConcept			CodeableConcept	Data type CodeableConcept
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].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. 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 can 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) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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
coding	Σ	0..*	Coding	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].coding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].coding.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. 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 can 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) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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
system	Σ	0..1	uri	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].coding.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 reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].coding.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() or (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:roleCode.value[x].coding.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 SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].coding.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 SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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..1	boolean	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. 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() or (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 ]
text	Σ	0..1	string	There are no (further) constraints on this element Element id Extension.extension:roleCode.value[x].text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
typedPeriod	I	1..*	Extension(Complex)	Element id Extension.extension:typedPeriod Short description Period of the role Alternate names extensions, user content Definition This supports the recording of a period related to the specified date type. The date/time period is carried along with a code to identify the type of period. 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(Complex) Extension URL https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	2..*	Extension	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.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. 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 can 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) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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
dateType	I	1..1	Extension	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:dateType Short description Whether the Date Period is 'Legal' or 'Operational'. Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can 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() or (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
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:dateType.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:dateType.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. 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 can 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) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:dateType.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 Fixed value dateType Mappings rim: N/A
value[x]		1..1	Binding	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:dateType.value[x] Short description A ValueSet to identify the type of period. Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding The type of period data. EnglandPeriodType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
valueCoding			Coding	There are no (further) constraints on this element Data type Coding
period	I	1..1	Extension	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:period Short description The specific business related date or time period. Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can 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() or (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
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:period.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:period.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. 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 can 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) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:period.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 Fixed value period Mappings rim: N/A
value[x]		1..1		There are no (further) constraints on this element Element id Extension.extension:typedPeriod.extension:period.value[x] Short description The date or time period. Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
valuePeriod			Period	There are no (further) constraints on this element Data type Period
url		1..1	uriFixed Value	There are no (further) constraints on this element Element id Extension.extension:typedPeriod.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 Fixed value https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod Mappings rim: N/A
value[x]		0..0		There are no (further) constraints on this element Element id Extension.extension:typedPeriod.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
active	I	1..1	Extension	Element id Extension.extension:active Short description Roles are either active or inactive Alternate names extensions, user content Definition Where the Boolean value is true, this means that the role is active. Conversely if the Boolean value is false, then this means that the role is inactive. 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() or (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
id		0..1	string	There are no (further) constraints on this element Element id Extension.extension:active.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:active.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. 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 can 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) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (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:active.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 Fixed value active Mappings rim: N/A
value[x]		1..1		There are no (further) constraints on this element Element id Extension.extension:active.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
valueBoolean			boolean	Data type boolean
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 Fixed value https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole Mappings 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 - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A

Table View

Extension		..
Extension.extension		4..
Extension.extension		1..1
Extension.extension.url		..
Extension.extension.value[x]	integer	1..
Extension.extension		1..1
Extension.extension.url		..
Extension.extension.value[x]	CodeableConcept	1..
Extension.extension.value[x].coding		..
Extension.extension.value[x].coding.code		1..
Extension.extension	Extension	1..
Extension.extension.url		..
Extension.extension		1..1
Extension.extension.url		..
Extension.extension.value[x]	boolean	1..
Extension.url		..
Extension.value[x]		..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-England-OrganisationRole" />
    <url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole" />
    <version value="1.0.0" />
    <name value="ExtensionEnglandOrganisationRole" />
    <title value="Extension England Organisation Role" />
    <status value="active" />
    <date value="2023-12-07" />
    <publisher value="NHS England" />
    <contact>
        <name value="NHS England" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="An extension to describe the role of the organisation." />
    <purpose value="This extension extends the Organization resource to support the NHS England requirement for additional information about organisational roles." />
    <copyright value="Copyright &#169; 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \&quot;License\&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at&#160; http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \&quot;AS IS\&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at&#160; https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Organization" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="An Extension to describe what an Organisation does." />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <min value="4" />
        </element>
        <element id="Extension.extension:instanceID">
            <path value="Extension.extension" />
            <sliceName value="instanceID" />
            <short value="Unique ID for each instance of an organisation role (organisation roles can be ended and then the organisation later undertakes same role again)." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Extension.extension:instanceID.url">
            <path value="Extension.extension.url" />
            <fixedUri value="instanceID" />
        </element>
        <element id="Extension.extension:instanceID.value[x]">
            <path value="Extension.extension.value[x]" />
            <min value="1" />
            <type>
                <code value="integer" />
            </type>
        </element>
        <element id="Extension.extension:roleCode">
            <path value="Extension.extension" />
            <sliceName value="roleCode" />
            <min value="1" />
            <max value="1" />
            <binding>
                <strength value="extensible" />
                <description value="A ValueSet to identify the organisation role codes" />
                <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-OrganisationRole" />
            </binding>
        </element>
        <element id="Extension.extension:roleCode.url">
            <path value="Extension.extension.url" />
            <fixedUri value="roleCode" />
        </element>
        <element id="Extension.extension:roleCode.value[x]">
            <path value="Extension.extension.value[x]" />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
        </element>
        <element id="Extension.extension:roleCode.value[x].coding.code">
            <path value="Extension.extension.value[x].coding.code" />
            <min value="1" />
        </element>
        <element id="Extension.extension:typedPeriod">
            <path value="Extension.extension" />
            <sliceName value="typedPeriod" />
            <short value="Period of the role" />
            <min value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" />
            </type>
        </element>
        <element id="Extension.extension:typedPeriod.url">
            <path value="Extension.extension.url" />
            <fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" />
        </element>
        <element id="Extension.extension:active">
            <path value="Extension.extension" />
            <sliceName value="active" />
            <short value="Roles are either active or inactive" />
            <definition value="Where the Boolean value is true, this means that the role is active. Conversely if the Boolean value is false, then this means that the role is inactive." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Extension.extension:active.url">
            <path value="Extension.extension.url" />
            <fixedUri value="active" />
        </element>
        <element id="Extension.extension:active.value[x]">
            <path value="Extension.extension.value[x]" />
            <min value="1" />
            <type>
                <code value="boolean" />
            </type>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-England-OrganisationRole",
    "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole",
    "version": "1.0.0",
    "name": "ExtensionEnglandOrganisationRole",
    "title": "Extension England Organisation Role",
    "status": "active",
    "date": "2023-12-07",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "An extension to describe the role of the organisation.",
    "purpose": "This extension extends the Organization resource to support the NHS England requirement for additional information about organisational roles.",
    "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Organization"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "An Extension to describe what an Organisation does."
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "min": 4
            },
            {
                "id": "Extension.extension:instanceID",
                "path": "Extension.extension",
                "sliceName": "instanceID",
                "short": "Unique ID for each instance of an organisation role (organisation roles can be ended and then the organisation later undertakes same role again).",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Extension.extension:instanceID.url",
                "path": "Extension.extension.url",
                "fixedUri": "instanceID"
            },
            {
                "id": "Extension.extension:instanceID.value[x]",
                "path": "Extension.extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "integer"
                    }
                ]
            },
            {
                "id": "Extension.extension:roleCode",
                "path": "Extension.extension",
                "sliceName": "roleCode",
                "min": 1,
                "max": "1",
                "binding": {
                    "strength": "extensible",
                    "description": "A ValueSet to identify the organisation role codes",
                    "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-OrganisationRole"
                }
            },
            {
                "id": "Extension.extension:roleCode.url",
                "path": "Extension.extension.url",
                "fixedUri": "roleCode"
            },
            {
                "id": "Extension.extension:roleCode.value[x]",
                "path": "Extension.extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ]
            },
            {
                "id": "Extension.extension:roleCode.value[x].coding.code",
                "path": "Extension.extension.value[x].coding.code",
                "min": 1
            },
            {
                "id": "Extension.extension:typedPeriod",
                "path": "Extension.extension",
                "sliceName": "typedPeriod",
                "short": "Period of the role",
                "min": 1,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod"
                        ]
                    }
                ]
            },
            {
                "id": "Extension.extension:typedPeriod.url",
                "path": "Extension.extension.url",
                "fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod"
            },
            {
                "id": "Extension.extension:active",
                "path": "Extension.extension",
                "sliceName": "active",
                "short": "Roles are either active or inactive",
                "definition": "Where the Boolean value is true, this means that the role is active. Conversely if the Boolean value is false, then this means that the role is inactive.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Extension.extension:active.url",
                "path": "Extension.extension.url",
                "fixedUri": "active"
            },
            {
                "id": "Extension.extension:active.value[x]",
                "path": "Extension.extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "boolean"
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}

NHS England Implementation Guide 1.2.0 - STU1

StructureDefinition Extension-England-OrganisationRole

Tree View

Table View

XML View

JSON View

Examples

Propose a change to Extension-England-OrganisationRole

Extension Specific Guidance