Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Profiles

Profiles

StructureDefinition UKCore-HealthCareService

UKCoreHealthcareService (HealthcareService)	I		HealthcareService	There are no (further) constraints on this element Element id HealthcareService Short description The details of a healthcare service available at a location Definition The details of a healthcare service available at a location. Data type HealthcareService Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act rim: act[classCode=ACT][moodCode=DEF]
id	Σ	0..1	string	There are no (further) constraints on this element Element id HealthcareService.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id HealthcareService.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id HealthcareService.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id HealthcareService.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id HealthcareService.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id HealthcareService.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id HealthcareService.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id HealthcareService.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id HealthcareService.identifier Short description External identifiers for this item Definition External identifiers for this item. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier rim: .id
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element id HealthcareService.active Short description Whether this HealthcareService record is in active use Definition This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. Comments This element is labeled as a modifier because it may be used to mark that the resource was created in error. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: .statusCode
providedBy	S Σ	0..1	Reference(Organization)	Element id HealthcareService.providedBy Short description The organization that provides this healthcare service. Definition The organization that provides this healthcare service. Comments This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .scopingRole.Organization
category	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element id HealthcareService.category Short description Broad category of service being performed or delivered Alternate names service category Definition Identifies the broad category of service being performed or delivered. Comments Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. Data type CodeableConcept Binding A category of the service(s) that could be provided. ServiceCategory (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class rim: .code
type	S Σ	0..*	CodeableConcept	Element id HealthcareService.type Short description The type of service provided by this healthcare service. Alternate names service type Definition The specific type of service that may be delivered or performed. Data type CodeableConcept Binding Additional details about where the content was created (e.g. clinical specialty). ServiceType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
specialty	Σ	0..*	CodeableConceptBinding	Element id HealthcareService.specialty Short description Specialties handled by the HealthcareService Definition Collection of specialties handled by the service site. This is more of a medical term. Data type CodeableConcept Binding A specialty that a healthcare service may provide. UKCorePracticeSettingCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
location	Σ	0..*	Reference(Location)	There are no (further) constraints on this element Element id HealthcareService.location Short description Location(s) where service may be provided Definition The location(s) where this healthcare service may be provided. Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.where[x] rim: .location.role[classCode=SDLOC]
name	Σ	0..1	string	There are no (further) constraints on this element Element id HealthcareService.name Short description Description of service as presented to a consumer while searching Definition Further description of the service as it would be presented to a consumer while searching. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .name
comment	Σ	0..1	string	There are no (further) constraints on this element Element id HealthcareService.comment Short description Additional description and/or any specific issues not covered elsewhere Definition Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. Comments Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .location.role[classCode=SDLOC].desc
extraDetails		0..1	markdown	There are no (further) constraints on this element Element id HealthcareService.extraDetails Short description Extra details about the service that can't be placed in the other fields Definition Extra details about the service that can't be placed in the other fields. Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text
photo	Σ	0..1	Attachment	There are no (further) constraints on this element Element id HealthcareService.photo Short description Facilitates quick identification of the service Definition If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. Data type Attachment Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=SBJ].observation.value
telecom		0..*	ContactPoint	There are no (further) constraints on this element Element id HealthcareService.telecom Short description Contacts related to the healthcare service Definition List of contacts related to this specific healthcare service. Comments If this is empty, then refer to the location's contacts. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .telecom
coverageArea		0..*	Reference(Location)	There are no (further) constraints on this element Element id HealthcareService.coverageArea Short description Location(s) service is intended for/available to Definition The location(s) that this service is available to (not where the service is provided). Comments The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home". Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate
serviceProvisionCode		0..*	CodeableConcept	There are no (further) constraints on this element Element id HealthcareService.serviceProvisionCode Short description Conditions under which service is available/offered Definition The code(s) that detail the conditions under which the healthcare service is available/offered. Comments The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply. Data type CodeableConcept Binding The code(s) that detail the conditions under which the healthcare service is available/offered. ServiceProvisionConditions (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
eligibility		0..*	BackboneElement	There are no (further) constraints on this element Element id HealthcareService.eligibility Short description Specific eligibility requirements required to use the service Definition Does this service have specific eligibility requirements that need to be met in order to use the service? Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id HealthcareService.eligibility.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 HealthcareService.eligibility.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id HealthcareService.eligibility.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
code		0..1	CodeableConcept	There are no (further) constraints on this element Element id HealthcareService.eligibility.code Short description Coded value for the eligibility Definition Coded value for the eligibility. Data type CodeableConcept Binding Coded values underwhich a specific service is made available. (unbound) (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
comment		0..1	markdown	There are no (further) constraints on this element Element id HealthcareService.eligibility.comment Short description Describes the eligibility conditions for the service Definition Describes the eligibility conditions for the service. Comments The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page. Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text
program		0..*	CodeableConcept	There are no (further) constraints on this element Element id HealthcareService.program Short description Programs that this service is applicable to Definition Programs that this service is applicable to. Comments Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. Data type CodeableConcept Binding Government or local programs that this service applies to. Program (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=PERT].observation
characteristic		0..*	CodeableConcept	There are no (further) constraints on this element Element id HealthcareService.characteristic Short description Collection of characteristics (attributes) Definition Collection of characteristics (attributes). Comments These could be such things as is wheelchair accessible. Data type CodeableConcept Binding A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). (unbound) (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=PERT].observation
communication		0..*	CodeableConceptBinding	Element id HealthcareService.communication Short description The language that this service is offered in Definition Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. Comments When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling. Data type CodeableConcept Binding A ValueSet that identifies the language used by a person. AllLanguages (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
referralMethod		0..*	CodeableConcept	There are no (further) constraints on this element Element id HealthcareService.referralMethod Short description Ways that the service accepts referrals Definition Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. Data type CodeableConcept Binding The methods of referral can be used when referring to a specific HealthCareService resource. ReferralMethod (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=PERT].observation
appointmentRequired		0..1	boolean	There are no (further) constraints on this element Element id HealthcareService.appointmentRequired Short description If an appointment is required for access to this service Definition Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .actrelationship[typeCode=PERT].observation
availableTime		0..*	BackboneElement	There are no (further) constraints on this element Element id HealthcareService.availableTime Short description Times the Service Site is available Definition A collection of times that the Service Site is available. Comments More detailed availability information may be provided in associated Schedule/Slot resources. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
id		0..1	string	There are no (further) constraints on this element Element id HealthcareService.availableTime.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 HealthcareService.availableTime.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id HealthcareService.availableTime.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
daysOfWeek		0..*	codeBinding	There are no (further) constraints on this element Element id HealthcareService.availableTime.daysOfWeek Short description mon \| tue \| wed \| thu \| fri \| sat \| sun Definition Indicates which days of the week are available between the start and end Times. Data type code Binding The days of the week. DaysOfWeek (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
allDay		0..1	boolean	There are no (further) constraints on this element Element id HealthcareService.availableTime.allDay Short description Always available? e.g. 24 hour service Definition Is this always available? (hence times are irrelevant) e.g. 24 hour service. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availableStartTime		0..1	time	There are no (further) constraints on this element Element id HealthcareService.availableTime.availableStartTime Short description Opening time of day (ignored if allDay = true) Definition The opening time of day. Note: If the AllDay flag is set, then this time is ignored. Comments The time zone is expected to be for where this HealthcareService is provided at. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availableEndTime		0..1	time	There are no (further) constraints on this element Element id HealthcareService.availableTime.availableEndTime Short description Closing time of day (ignored if allDay = true) Definition The closing time of day. Note: If the AllDay flag is set, then this time is ignored. Comments The time zone is expected to be for where this HealthcareService is provided at. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
notAvailable		0..*	BackboneElement	There are no (further) constraints on this element Element id HealthcareService.notAvailable Short description Not available during this time due to provided reason Definition The HealthcareService is not available during this period of time due to the provided reason. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
id		0..1	string	There are no (further) constraints on this element Element id HealthcareService.notAvailable.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 HealthcareService.notAvailable.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id HealthcareService.notAvailable.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
description		1..1	string	There are no (further) constraints on this element Element id HealthcareService.notAvailable.description Short description Reason presented to the user explaining why time not available Definition The reason that can be presented to the user as to why this time is not available. 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
during		0..1	Period	There are no (further) constraints on this element Element id HealthcareService.notAvailable.during Short description Service not available from this date Definition Service is not available (seasonally or for a public holiday) from this date. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availabilityExceptions		0..1	string	There are no (further) constraints on this element Element id HealthcareService.availabilityExceptions Short description Description of availability exceptions Definition A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
endpoint		0..*	Reference(Endpoint)	There are no (further) constraints on this element Element id HealthcareService.endpoint Short description Technical endpoints providing access to electronic services operated for the healthcare service Definition Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. Data type Reference(Endpoint) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

HealthcareService
Definition	The details of a healthcare service available at a location.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act rim: act[classCode=ACT][moodCode=DEF]
HealthcareService.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
HealthcareService.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
HealthcareService.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
HealthcareService.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
HealthcareService.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
HealthcareService.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
HealthcareService.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
HealthcareService.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
HealthcareService.identifier
Definition	External identifiers for this item.
Cardinality	0...*
Type	Identifier
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier rim: .id
HealthcareService.active
Definition	This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.
Cardinality	0...1
Type	boolean
Modifier	True
Summary	True
Comments	This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status rim: .statusCode
HealthcareService.providedBy
Definition	The organization that provides this healthcare service.
Cardinality	0...1
Type	Reference(Organization)
Must Support	True
Summary	True
Comments	This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .scopingRole.Organization
HealthcareService.category
Definition	Identifies the broad category of service being performed or delivered.
Cardinality	0...*
Type	CodeableConcept
Binding	A category of the service(s) that could be provided. ServiceCategory (example)
Summary	True
Alias	service category
Comments	Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class rim: .code
HealthcareService.type
Definition	The specific type of service that may be delivered or performed.
Cardinality	0...*
Type	CodeableConcept
Binding	Additional details about where the content was created (e.g. clinical specialty). ServiceType (example)
Must Support	True
Summary	True
Alias	service type
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
HealthcareService.specialty
Definition	Collection of specialties handled by the service site. This is more of a medical term.
Cardinality	0...*
Type	CodeableConcept
Binding	A specialty that a healthcare service may provide. UKCorePracticeSettingCode (extensible)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
HealthcareService.location
Definition	The location(s) where this healthcare service may be provided.
Cardinality	0...*
Type	Reference(Location)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.where[x] rim: .location.role[classCode=SDLOC]
HealthcareService.name
Definition	Further description of the service as it would be presented to a consumer while searching.
Cardinality	0...1
Type	string
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .name
HealthcareService.comment
Definition	Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
Cardinality	0...1
Type	string
Summary	True
Comments	Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .location.role[classCode=SDLOC].desc
HealthcareService.extraDetails
Definition	Extra details about the service that can't be placed in the other fields.
Cardinality	0...1
Type	markdown
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text
HealthcareService.photo
Definition	If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
Cardinality	0...1
Type	Attachment
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=SBJ].observation.value
HealthcareService.telecom
Definition	List of contacts related to this specific healthcare service.
Cardinality	0...*
Type	ContactPoint
Comments	If this is empty, then refer to the location's contacts.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .telecom
HealthcareService.coverageArea
Definition	The location(s) that this service is available to (not where the service is provided).
Cardinality	0...*
Type	Reference(Location)
Comments	The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate
HealthcareService.serviceProvisionCode
Definition	The code(s) that detail the conditions under which the healthcare service is available/offered.
Cardinality	0...*
Type	CodeableConcept
Binding	The code(s) that detail the conditions under which the healthcare service is available/offered. ServiceProvisionConditions (example)
Comments	The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
HealthcareService.eligibility
Definition	Does this service have specific eligibility requirements that need to be met in order to use the service?
Cardinality	0...*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
HealthcareService.eligibility.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
Mappings	rim: n/a
HealthcareService.eligibility.extension
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.
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.
Invariants	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
HealthcareService.eligibility.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
HealthcareService.eligibility.code
Definition	Coded value for the eligibility.
Cardinality	0...1
Type	CodeableConcept
Binding	Coded values underwhich a specific service is made available. (unbound) (example)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
HealthcareService.eligibility.comment
Definition	Describes the eligibility conditions for the service.
Cardinality	0...1
Type	markdown
Comments	The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text
HealthcareService.program
Definition	Programs that this service is applicable to.
Cardinality	0...*
Type	CodeableConcept
Binding	Government or local programs that this service applies to. Program (example)
Comments	Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=PERT].observation
HealthcareService.characteristic
Definition	Collection of characteristics (attributes).
Cardinality	0...*
Type	CodeableConcept
Binding	A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). (unbound) (example)
Comments	These could be such things as is wheelchair accessible.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=PERT].observation
HealthcareService.communication
Definition	Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.
Cardinality	0...*
Type	CodeableConcept
Binding	A ValueSet that identifies the language used by a person. AllLanguages (required)
Comments	When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
HealthcareService.referralMethod
Definition	Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
Cardinality	0...*
Type	CodeableConcept
Binding	The methods of referral can be used when referring to a specific HealthCareService resource. ReferralMethod (example)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=PERT].observation
HealthcareService.appointmentRequired
Definition	Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
Cardinality	0...1
Type	boolean
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .actrelationship[typeCode=PERT].observation
HealthcareService.availableTime
Definition	A collection of times that the Service Site is available.
Cardinality	0...*
Type	BackboneElement
Comments	More detailed availability information may be provided in associated Schedule/Slot resources.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
HealthcareService.availableTime.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
Mappings	rim: n/a
HealthcareService.availableTime.extension
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.
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.
Invariants	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
HealthcareService.availableTime.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
HealthcareService.availableTime.daysOfWeek
Definition	Indicates which days of the week are available between the start and end Times.
Cardinality	0...*
Type	code
Binding	The days of the week. DaysOfWeek (required)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
HealthcareService.availableTime.allDay
Definition	Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Cardinality	0...1
Type	boolean
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
HealthcareService.availableTime.availableStartTime
Definition	The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
Cardinality	0...1
Type	time
Comments	The time zone is expected to be for where this HealthcareService is provided at.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
HealthcareService.availableTime.availableEndTime
Definition	The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Cardinality	0...1
Type	time
Comments	The time zone is expected to be for where this HealthcareService is provided at.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
HealthcareService.notAvailable
Definition	The HealthcareService is not available during this period of time due to the provided reason.
Cardinality	0...*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
HealthcareService.notAvailable.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
Mappings	rim: n/a
HealthcareService.notAvailable.extension
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.
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.
Invariants	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
HealthcareService.notAvailable.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
HealthcareService.notAvailable.description
Definition	The reason that can be presented to the user as to why this time is not available.
Cardinality	1...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
HealthcareService.notAvailable.during
Definition	Service is not available (seasonally or for a public holiday) from this date.
Cardinality	0...1
Type	Period
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
HealthcareService.availabilityExceptions
Definition	A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
Cardinality	0...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
HealthcareService.endpoint
Definition	Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
Cardinality	0...*
Type	Reference(Endpoint)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a

HealthcareService		..
HealthcareService.providedBy		..
HealthcareService.type		..
HealthcareService.specialty		..
HealthcareService.communication		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-HealthcareService" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService" />
    <version value="1.3.0" />
    <name value="UKCoreHealthcareService" />
    <title value="UK Core HealthcareService" />
    <status value="active" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [HealthcareService](https://hl7.org/fhir/R4/HealthcareService.html)." />
    <purpose value="This profile is used to describe a single healthcare service or category of services that are provided by an organisation at a location, including a virtual location." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="HealthcareService" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/HealthcareService" />
    <derivation value="constraint" />
    <differential>
        <element id="HealthcareService.providedBy">
            <path value="HealthcareService.providedBy" />
            <short value="The organization that provides this healthcare service." />
            <mustSupport value="true" />
        </element>
        <element id="HealthcareService.type">
            <path value="HealthcareService.type" />
            <short value="The type of service provided by this healthcare service." />
            <mustSupport value="true" />
        </element>
        <element id="HealthcareService.specialty">
            <path value="HealthcareService.specialty" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" />
            </binding>
        </element>
        <element id="HealthcareService.communication">
            <path value="HealthcareService.communication" />
            <binding>
                <strength value="required" />
                <description value="A ValueSet that identifies the language used by a person." />
                <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-HealthcareService",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService",
    "version": "1.3.0",
    "name": "UKCoreHealthcareService",
    "title": "UK Core HealthcareService",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [HealthcareService](https://hl7.org/fhir/R4/HealthcareService.html).",
    "purpose": "This profile is used to describe a single healthcare service or category of services that are provided by an organisation at a location, including a virtual location.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "HealthcareService",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "HealthcareService.providedBy",
                "path": "HealthcareService.providedBy",
                "short": "The organization that provides this healthcare service.",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.type",
                "path": "HealthcareService.type",
                "short": "The type of service provided by this healthcare service.",
                "mustSupport": true
            },
            {
                "id": "HealthcareService.specialty",
                "path": "HealthcareService.specialty",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode"
                }
            },
            {
                "id": "HealthcareService.communication",
                "path": "HealthcareService.communication",
                "binding": {
                    "strength": "required",
                    "description": "A ValueSet that identifies the language used by a person.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
                }
            }
        ]
    }
}

Examples

An example to illustrate information about an orthopaedic service within a HealthcareService resource

Example UKCore-HealthcareService-OrthopaedicService

Propose a change to UK Core HealthCareService

StructureDefinition UKCore-Location

UKCoreLocation (Location)	I		Location	There are no (further) constraints on this element Element id Location Short description Details and position information for a physical place Definition Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. Data type Location Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act rim: .Role[classCode=SDLC]
id	Σ	0..1	string	There are no (further) constraints on this element Element id Location.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Location.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Location.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Location.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Location.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Location.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Location.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Location.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	Σ	0..*	Identifier	Element id Location.identifier Short description Unique code or number identifying the location to its users Definition Unique code or number identifying the location to its users. Requirements Organization label locations in registries, need to keep track of those. Data type Identifier Sliced: Unordered, Open, by system(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier rim: .id
odsSiteCode	S Σ	0..1	Identifier	Element id Location.identifier:odsSiteCode Short description ODS Site code to identify the organisation at site level Definition ODS Site code to identify the organisation at site level. Requirements Organization label locations in registries, need to keep track of those. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier rim: .id
id		0..1	string	There are no (further) constraints on this element Element id Location.identifier:odsSiteCode.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 Location.identifier:odsSiteCode.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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Location.identifier:odsSiteCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Location.identifier:odsSiteCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element id Location.identifier:odsSiteCode.system Short description ODS Code Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.nhs.uk/Id/ods-site-code Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Location.identifier:odsSiteCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Location.identifier:odsSiteCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Location.identifier:odsSiteCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
status	S Σ ?!	0..1	codeBinding	Element id Location.status Short description Is the location active, inactive, or suspended Definition The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location. Data type code Binding Indicates whether the location is still in use. LocationStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: .statusCode
operationalStatus	Σ	0..1	CodingBinding	There are no (further) constraints on this element Element id Location.operationalStatus Short description The operational status of the location (typically only for a bed/room) Definition The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. Data type Coding Binding The operational status if the location (where typically a bed/room). v2.0116 (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: n/a
name	S Σ	0..1	string	Element id Location.name Short description Name of the location as used by humans. This does not need to be unique. Definition Name of the location as used by humans. Does not need to be unique. Comments If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .name
alias		0..*	string	There are no (further) constraints on this element Element id Location.alias Short description A list of alternate names that the location is known as, or was known as, in the past Definition A list of alternate names that the location is known as, or was known as, in the past. Requirements Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful. Comments There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .name
description	Σ	0..1	string	There are no (further) constraints on this element Element id Location.description Short description Additional details about the location that could be displayed as further information to identify the location beyond its name Definition Description of the Location, which helps in finding or referencing the place. Requirements Humans need additional information to verify a correct location has been identified. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity[classCode=PLC determinerCode=INSTANCE].desc
mode	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id Location.mode Short description instance \| kind Definition Indicates whether a resource instance represents a specific location or a class of locations. Requirements When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location. Comments This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood. Data type code Binding Indicates whether a resource instance represents a specific location or a class of locations. LocationMode (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class rim: .playingEntity[classCode=PLC].determinerCode
type	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Location.type Short description Type of function performed Definition Indicates the type of function performed at the location. Data type CodeableConcept Binding Indicates the type of function performed at the location. v3.ServiceDeliveryLocationRoleType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class rim: .code
telecom		0..*	ContactPoint	There are no (further) constraints on this element Element id Location.telecom Short description Contact details of the location Definition The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .telecom
address	S	0..1	Address	Element id Location.address Short description If locations can be visited, we need to keep track of their address. Definition Physical location. Requirements If locations can be visited, we need to keep track of their address. Comments Additional addresses should be recorded using another instance of the Location resource, or via the Organization. Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .addr
physicalType	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element id Location.physicalType Short description Physical form of the location Definition Physical form of the location, e.g. building, room, vehicle, road. Requirements For purposes of showing relevant locations in queries, we need to categorize locations. Data type CodeableConcept Binding Physical form of the location. LocationType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class rim: .playingEntity [classCode=PLC].code
position		0..1	BackboneElement	There are no (further) constraints on this element Element id Location.position Short description The absolute geographic location Definition The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). Requirements For mobile applications and automated route-finding knowing the exact location of the Location is required. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity [classCode=PLC determinerCode=INSTANCE].positionText
id		0..1	string	There are no (further) constraints on this element Element id Location.position.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 Location.position.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Location.position.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
longitude		1..1	decimal	There are no (further) constraints on this element Element id Location.position.longitude Short description Longitude with WGS84 datum Definition Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Data type decimal Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
latitude		1..1	decimal	There are no (further) constraints on this element Element id Location.position.latitude Short description Latitude with WGS84 datum Definition Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Data type decimal Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
altitude		0..1	decimal	There are no (further) constraints on this element Element id Location.position.altitude Short description Altitude with WGS84 datum Definition Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Data type decimal Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
managingOrganization	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Location.managingOrganization Short description Organization responsible for provisioning and upkeep Definition The organization responsible for the provisioning and upkeep of the location. Requirements Need to know who manages the location. Comments This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .scopingEntity[classCode=ORG determinerKind=INSTANCE]
partOf		0..1	Reference(Location)	There are no (further) constraints on this element Element id Location.partOf Short description Another Location this one is physically a part of Definition Another Location of which this Location is physically a part of. Requirements For purposes of location, display and identification, knowing which locations are located within other locations is important. Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .inboundLink[typeCode=PART].source[classCode=SDLC]
hoursOfOperation		0..*	BackboneElement	There are no (further) constraints on this element Element id Location.hoursOfOperation Short description What days/times during a week is this location usually open Definition What days/times during a week is this location usually open. Comments This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
id		0..1	string	There are no (further) constraints on this element Element id Location.hoursOfOperation.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 Location.hoursOfOperation.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Location.hoursOfOperation.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
daysOfWeek		0..*	codeBinding	There are no (further) constraints on this element Element id Location.hoursOfOperation.daysOfWeek Short description mon \| tue \| wed \| thu \| fri \| sat \| sun Definition Indicates which days of the week are available between the start and end Times. Data type code Binding The days of the week. DaysOfWeek (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
allDay		0..1	boolean	There are no (further) constraints on this element Element id Location.hoursOfOperation.allDay Short description The Location is open all day Definition The Location is open all day. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
openingTime		0..1	time	There are no (further) constraints on this element Element id Location.hoursOfOperation.openingTime Short description Time that the Location opens Definition Time that the Location opens. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
closingTime		0..1	time	There are no (further) constraints on this element Element id Location.hoursOfOperation.closingTime Short description Time that the Location closes Definition Time that the Location closes. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availabilityExceptions		0..1	string	There are no (further) constraints on this element Element id Location.availabilityExceptions Short description Description of availability exceptions Definition A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times. 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
endpoint		0..*	Reference(Endpoint)	There are no (further) constraints on this element Element id Location.endpoint Short description Technical endpoints providing access to services operated for the location Definition Technical endpoints providing access to services operated for the location. Requirements Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. Data type Reference(Endpoint) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

Location
Definition	Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act rim: .Role[classCode=SDLC]
Location.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Location.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Location.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Location.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Location.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
Location.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
Location.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
Location.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Location.identifier
Definition	Unique code or number identifying the location to its users.
Cardinality	0...*
Type	Identifier
Summary	True
Requirements	Organization label locations in registries, need to keep track of those.
Slicing	Unordered, Open, by system(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier rim: .id
Location.identifier:odsSiteCode
Definition	ODS Site code to identify the organisation at site level.
Cardinality	0...1
Type	Identifier
Must Support	True
Summary	True
Requirements	Organization label locations in registries, need to keep track of those.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier rim: .id
Location.identifier:odsSiteCode.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
Mappings	rim: n/a
Location.identifier:odsSiteCode.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Location.identifier:odsSiteCode.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: N/A rim: Role.code or implied by context
Location.identifier:odsSiteCode.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.5 rim: Role.code or implied by context
Location.identifier:odsSiteCode.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	https://fhir.nhs.uk/Id/ods-site-code
Mappings	v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Location.identifier:odsSiteCode.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
Location.identifier:odsSiteCode.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
Location.identifier:odsSiteCode.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
Location.status
Definition	The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
Cardinality	0...1
Type	code
Binding	Indicates whether the location is still in use. LocationStatus (required)
Must Support	True
Modifier	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status rim: .statusCode
Location.operationalStatus
Definition	The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
Cardinality	0...1
Type	Coding
Binding	The operational status if the location (where typically a bed/room). v2.0116 (preferred)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status rim: n/a
Location.name
Definition	Name of the location as used by humans. Does not need to be unique.
Cardinality	0...1
Type	string
Must Support	True
Summary	True
Comments	If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .name
Location.alias
Definition	A list of alternate names that the location is known as, or was known as, in the past.
Cardinality	0...*
Type	string
Requirements	Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful.
Comments	There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .name
Location.description
Definition	Description of the Location, which helps in finding or referencing the place.
Cardinality	0...1
Type	string
Summary	True
Requirements	Humans need additional information to verify a correct location has been identified.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity[classCode=PLC determinerCode=INSTANCE].desc
Location.mode
Definition	Indicates whether a resource instance represents a specific location or a class of locations.
Cardinality	0...1
Type	code
Binding	Indicates whether a resource instance represents a specific location or a class of locations. LocationMode (required)
Summary	True
Requirements	When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.
Comments	This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class rim: .playingEntity[classCode=PLC].determinerCode
Location.type
Definition	Indicates the type of function performed at the location.
Cardinality	0...*
Type	CodeableConcept
Binding	Indicates the type of function performed at the location. v3.ServiceDeliveryLocationRoleType (extensible)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class rim: .code
Location.telecom
Definition	The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
Cardinality	0...*
Type	ContactPoint
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .telecom
Location.address
Definition	Physical location.
Cardinality	0...1
Type	Address
Must Support	True
Requirements	If locations can be visited, we need to keep track of their address.
Comments	Additional addresses should be recorded using another instance of the Location resource, or via the Organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .addr
Location.physicalType
Definition	Physical form of the location, e.g. building, room, vehicle, road.
Cardinality	0...1
Type	CodeableConcept
Binding	Physical form of the location. LocationType (example)
Summary	True
Requirements	For purposes of showing relevant locations in queries, we need to categorize locations.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class rim: .playingEntity [classCode=PLC].code
Location.position
Definition	The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
Cardinality	0...1
Type	BackboneElement
Requirements	For mobile applications and automated route-finding knowing the exact location of the Location is required.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity [classCode=PLC determinerCode=INSTANCE].positionText
Location.position.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
Mappings	rim: n/a
Location.position.extension
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.
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.
Invariants	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
Location.position.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Location.position.longitude
Definition	Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
Cardinality	1...1
Type	decimal
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Location.position.latitude
Definition	Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
Cardinality	1...1
Type	decimal
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Location.position.altitude
Definition	Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
Cardinality	0...1
Type	decimal
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: (RIM Opted not to map the sub-elements of GPS location, is now an OBS)
Location.managingOrganization
Definition	The organization responsible for the provisioning and upkeep of the location.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Requirements	Need to know who manages the location.
Comments	This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .scopingEntity[classCode=ORG determinerKind=INSTANCE]
Location.partOf
Definition	Another Location of which this Location is physically a part of.
Cardinality	0...1
Type	Reference(Location)
Requirements	For purposes of location, display and identification, knowing which locations are located within other locations is important.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .inboundLink[typeCode=PART].source[classCode=SDLC]
Location.hoursOfOperation
Definition	What days/times during a week is this location usually open.
Cardinality	0...*
Type	BackboneElement
Comments	This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
Location.hoursOfOperation.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
Mappings	rim: n/a
Location.hoursOfOperation.extension
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.
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.
Invariants	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
Location.hoursOfOperation.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Location.hoursOfOperation.daysOfWeek
Definition	Indicates which days of the week are available between the start and end Times.
Cardinality	0...*
Type	code
Binding	The days of the week. DaysOfWeek (required)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
Location.hoursOfOperation.allDay
Definition	The Location is open all day.
Cardinality	0...1
Type	boolean
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
Location.hoursOfOperation.openingTime
Definition	Time that the Location opens.
Cardinality	0...1
Type	time
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
Location.hoursOfOperation.closingTime
Definition	Time that the Location closes.
Cardinality	0...1
Type	time
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
Location.availabilityExceptions
Definition	A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
Cardinality	0...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Location.endpoint
Definition	Technical endpoints providing access to services operated for the location.
Cardinality	0...*
Type	Reference(Endpoint)
Requirements	Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a

Location		..
Location.identifier		..
Location.identifier		..1
Location.identifier.system		1..
Location.identifier.value		1..
Location.status		..
Location.name		..
Location.address		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Location" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
    <version value="2.3.0" />
    <name value="UKCoreLocation" />
    <title value="UK Core Location" />
    <status value="active" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Location](https://hl7.org/fhir/R4/Location.html)." />
    <purpose value="This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.\n\nA location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Location" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Location" />
    <derivation value="constraint" />
    <differential>
        <element id="Location.identifier">
            <path value="Location.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <rules value="open" />
            </slicing>
        </element>
        <element id="Location.identifier:odsSiteCode">
            <path value="Location.identifier" />
            <sliceName value="odsSiteCode" />
            <short value="ODS Site code to identify the organisation at site level" />
            <definition value="ODS Site code to identify the organisation at site level." />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Location.identifier:odsSiteCode.system">
            <path value="Location.identifier.system" />
            <short value="ODS Code" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/ods-site-code" />
        </element>
        <element id="Location.identifier:odsSiteCode.value">
            <path value="Location.identifier.value" />
            <min value="1" />
        </element>
        <element id="Location.status">
            <path value="Location.status" />
            <short value="Is the location active, inactive, or suspended" />
            <mustSupport value="true" />
        </element>
        <element id="Location.name">
            <path value="Location.name" />
            <short value="Name of the location as used by humans. This does not need to be unique." />
            <mustSupport value="true" />
        </element>
        <element id="Location.address">
            <path value="Location.address" />
            <short value="If locations can be visited, we need to keep track of their address." />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Location",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location",
    "version": "2.3.0",
    "name": "UKCoreLocation",
    "title": "UK Core Location",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Location](https://hl7.org/fhir/R4/Location.html).",
    "purpose": "This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.\n\nA location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "Location",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Location",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Location.identifier",
                "path": "Location.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Location.identifier:odsSiteCode",
                "path": "Location.identifier",
                "sliceName": "odsSiteCode",
                "short": "ODS Site code to identify the organisation at site level",
                "definition": "ODS Site code to identify the organisation at site level.",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Location.identifier:odsSiteCode.system",
                "path": "Location.identifier.system",
                "short": "ODS Code",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/ods-site-code"
            },
            {
                "id": "Location.identifier:odsSiteCode.value",
                "path": "Location.identifier.value",
                "min": 1
            },
            {
                "id": "Location.status",
                "path": "Location.status",
                "short": "Is the location active, inactive, or suspended",
                "mustSupport": true
            },
            {
                "id": "Location.name",
                "path": "Location.name",
                "short": "Name of the location as used by humans. This does not need to be unique.",
                "mustSupport": true
            },
            {
                "id": "Location.address",
                "path": "Location.address",
                "short": "If locations can be visited, we need to keep track of their address.",
                "mustSupport": true
            }
        ]
    }
}

Examples

1. An example to illustrate a clinical unit within a hospital

Example UKCore-Location-CardiologySJUH

2. An example to illustrate a GP clinic location

Example UKCore-Location-GeneralPracticeNurseClinic

Propose a change to UK Core Location

StructureDefinition UKCore-Organization

UKCoreOrganization (Organization)	I		Organization	There are no (further) constraints on this element Element id Organization Short description A grouping of people or organizations with a common purpose Definition A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. Data type Organization Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() org-1: The organization SHALL at least have a name or an identifier, and possibly more than one `(identifier.count() + name.count()) > 0` Mappings rim: Entity. Role, or Act v2: (also see master files messages) rim: Organization(classCode=ORG, determinerCode=INST) servd: Organization
id	Σ	0..1	string	There are no (further) constraints on this element Element id Organization.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Organization.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Organization.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Organization.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Organization.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Organization.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	Element id Organization.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 resource. 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) 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
mainLocation	I	0..1	Extension(Reference(Location))	Element id Organization.extension:mainLocation Short description The main location of the organisation. Alternate names extensions, user content Definition The main location of the organisation. 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(Reference(Location)) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation 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
organizationPeriod	I	0..1	Extension(Period)	Element id Organization.extension:organizationPeriod Short description The date range that this organization SHOULD be considered available. Alternate names extensions, user content Definition The date range that this organization SHOULD be considered available. 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(Period) Extension URL http://hl7.org/fhir/StructureDefinition/organization-period 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
id		0..1	string	There are no (further) constraints on this element Element id Organization.extension:organizationPeriod.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..0	Extension	There are no (further) constraints on this element Element id Organization.extension:organizationPeriod.extension Short description Extension Definition An Extension 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()`
url		1..1	uriFixed Value	There are no (further) constraints on this element Element id Organization.extension:organizationPeriod.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 http://hl7.org/fhir/StructureDefinition/organization-period Mappings rim: N/A
value[x]		1..1		Element id Organization.extension:organizationPeriod.value[x] Short description The date range that this organization SHOULD be considered available. Definition The date range that this organization SHOULD be considered available. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valuePeriod			Period	There are no (further) constraints on this element Data type Period
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Organization.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	S Σ I	0..*	Identifier	Element id Organization.identifier Short description Identifies this organization across multiple systems. Definition Identifier for the organization that is used to identify the organization across multiple disparate systems. Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Data type Identifier Sliced: Unordered, Open, by system(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
odsOrganisationCode	Σ I	0..1	Identifier	Element id Organization.identifier:odsOrganisationCode Short description Organisation Data Service code Definition Identifier code supplier by the Organisation Data Service. Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
id		0..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.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 Organization.identifier:odsOrganisationCode.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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element id Organization.identifier:odsOrganisationCode.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.nhs.uk/Id/ods-organization-code Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.identifier:odsOrganisationCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
odsSiteCode	Σ I	0..1	Identifier	Element id Organization.identifier:odsSiteCode Short description ODS Site code to identify the organisation at site level Definition ODS Site code to identify the organisation at site level. Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
id		0..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.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 Organization.identifier:odsSiteCode.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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element id Organization.identifier:odsSiteCode.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.nhs.uk/Id/ods-site-code Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.identifier:odsSiteCode.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
active	S Σ ?!	0..1	boolean	Element id Organization.active Short description Identifies this organization across multiple systems. Definition Whether the organization's record is still in active use. Requirements Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. Comments This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status v2: No equivalent in HL7 v2 rim: .status servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
type	Σ	0..*	CodeableConceptBinding	Element id Organization.type Short description Kind of organization Definition The kind(s) of organization that this is. Requirements Need to be able to track the kind of organization that this is - different organization types have different uses. Comments Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality. Data type CodeableConcept Binding A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts UKCoreOrganizationType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class v2: No equivalent in v2 rim: .code servd: n/a
name	S Σ I	0..1	string	Element id Organization.name Short description A name associated with the organization. Definition A name associated with the organization. Requirements Need to use the name as the label of the organization. Comments If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XON.1 rim: .name servd: .PreferredName/Name
alias		0..*	string	There are no (further) constraints on this element Element id Organization.alias Short description A list of alternate names that the organization is known as, or was known as in the past Definition A list of alternate names that the organization is known as, or was known as in the past. Requirements Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. Comments There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .name
telecom	S I	0..*	ContactPoint	Element id Organization.telecom Short description Contact details for the organization. Definition A contact detail for the organization. Requirements Human contact for the organization. Comments The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-3: The telecom of an organization can never be of use 'home' `where(use = 'home').empty()` Mappings v2: ORC-22? rim: .telecom servd: ./ContactPoints
address	S I	0..*	Address	Element id Organization.address Short description An address for the organization. Definition An address for the organization. Requirements May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Comments Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used. Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-2: An address of an organization can never be of use 'home' `where(use = 'home').empty()` Mappings v2: ORC-23? rim: .address servd: ./PrimaryAddress and ./OtherAddresses
partOf	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Organization.partOf Short description The organization of which this organization forms a part Definition The organization of which this organization forms a part. Requirements Need to be able to track the hierarchy of organizations within an organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: No equivalent in HL7 v2 rim: .playedBy[classCode=Part].scoper servd: n/a
contact		0..*	BackboneElement	There are no (further) constraints on this element Element id Organization.contact Short description Contact for the organization for a certain purpose Definition Contact for the organization for a certain purpose. Requirements Need to keep track of assigned contact points within bigger organization. Comments Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .contactParty
id		0..1	string	There are no (further) constraints on this element Element id Organization.contact.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 Organization.contact.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Organization.contact.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
purpose		0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Organization.contact.purpose Short description The type of contact Definition Indicates a purpose for which the contact can be reached. Requirements Need to distinguish between multiple contact persons. Data type CodeableConcept Binding The purpose for which you would contact a contact party. ContactEntityType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./type
name		0..1	HumanName	There are no (further) constraints on this element Element id Organization.contact.name Short description A name associated with the contact Definition A name associated with the contact. Requirements Need to be able to track the person by name. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-5, PID-9 rim: ./name
telecom		0..*	ContactPoint	There are no (further) constraints on this element Element id Organization.contact.telecom Short description Contact details (telephone, email, etc.) for a contact Definition A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. Requirements People have (primary) ways to contact them in some way such as phone, email. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-13, PID-14 rim: ./telecom
address		0..1	Address	There are no (further) constraints on this element Element id Organization.contact.address Short description Visiting or postal addresses for the contact Definition Visiting or postal addresses for the contact. Requirements May need to keep track of a contact party's address for contacting, billing or reporting requirements. Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-11 rim: ./addr
endpoint		0..*	Reference(Endpoint)	There are no (further) constraints on this element Element id Organization.endpoint Short description Technical endpoints providing access to services operated for the organization Definition Technical endpoints providing access to services operated for the organization. Requirements Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. Data type Reference(Endpoint) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

Organization
Definition	A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() org-1: The organization SHALL at least have a name or an identifier, and possibly more than one `(identifier.count() + name.count()) > 0`
Mappings	rim: Entity. Role, or Act v2: (also see master files messages) rim: Organization(classCode=ORG, determinerCode=INST) servd: Organization
Organization.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Organization.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Organization.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Organization.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Organization.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
Organization.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
Organization.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Organization.extension:mainLocation
Definition	The main location of the organisation.
Cardinality	0...1
Type	Extension(Reference(Location))
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() 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
Organization.extension:organizationPeriod
Definition	The date range that this organization SHOULD be considered available.
Cardinality	0...1
Type	Extension(Period)
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Organization.extension:organizationPeriod.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
Mappings	rim: n/a
Organization.extension:organizationPeriod.extension
Definition	An Extension
Cardinality	0...0
Type	Extension
Slicing	Unordered, Open, by url(Value)
Invariants	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()`
Organization.extension:organizationPeriod.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.
Fixed Value	http://hl7.org/fhir/StructureDefinition/organization-period
Mappings	rim: N/A
Organization.extension:organizationPeriod.value[x]
Definition	The date range that this organization SHOULD be considered available.
Cardinality	1...1
Type	Period
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
Organization.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Organization.identifier
Definition	Identifier for the organization that is used to identify the organization across multiple disparate systems.
Cardinality	0...*
Type	Identifier
Must Support	True
Summary	True
Requirements	Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Slicing	Unordered, Open, by system(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
Organization.identifier:odsOrganisationCode
Definition	Identifier code supplier by the Organisation Data Service.
Cardinality	0...1
Type	Identifier
Summary	True
Requirements	Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
Organization.identifier:odsOrganisationCode.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
Mappings	rim: n/a
Organization.identifier:odsOrganisationCode.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Organization.identifier:odsOrganisationCode.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: N/A rim: Role.code or implied by context
Organization.identifier:odsOrganisationCode.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.5 rim: Role.code or implied by context
Organization.identifier:odsOrganisationCode.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	https://fhir.nhs.uk/Id/ods-organization-code
Mappings	v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Organization.identifier:odsOrganisationCode.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
Organization.identifier:odsOrganisationCode.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
Organization.identifier:odsOrganisationCode.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
Organization.identifier:odsSiteCode
Definition	ODS Site code to identify the organisation at site level.
Cardinality	0...1
Type	Identifier
Summary	True
Requirements	Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: XON.10 / XON.3 rim: .scopes[Role](classCode=IDENT) servd: ./Identifiers
Organization.identifier:odsSiteCode.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
Mappings	rim: n/a
Organization.identifier:odsSiteCode.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Organization.identifier:odsSiteCode.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: N/A rim: Role.code or implied by context
Organization.identifier:odsSiteCode.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.5 rim: Role.code or implied by context
Organization.identifier:odsSiteCode.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	https://fhir.nhs.uk/Id/ods-site-code
Mappings	v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Organization.identifier:odsSiteCode.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
Organization.identifier:odsSiteCode.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
Organization.identifier:odsSiteCode.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
Organization.active
Definition	Whether the organization's record is still in active use.
Cardinality	0...1
Type	boolean
Must Support	True
Modifier	True
Summary	True
Requirements	Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.
Comments	This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status v2: No equivalent in HL7 v2 rim: .status servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
Organization.type
Definition	The kind(s) of organization that this is.
Cardinality	0...*
Type	CodeableConcept
Binding	A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts UKCoreOrganizationType (extensible)
Summary	True
Requirements	Need to be able to track the kind of organization that this is - different organization types have different uses.
Comments	Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class v2: No equivalent in v2 rim: .code servd: n/a
Organization.name
Definition	A name associated with the organization.
Cardinality	0...1
Type	string
Must Support	True
Summary	True
Requirements	Need to use the name as the label of the organization.
Comments	If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XON.1 rim: .name servd: .PreferredName/Name
Organization.alias
Definition	A list of alternate names that the organization is known as, or was known as in the past.
Cardinality	0...*
Type	string
Requirements	Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful.
Comments	There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .name
Organization.telecom
Definition	A contact detail for the organization.
Cardinality	0...*
Type	ContactPoint
Must Support	True
Requirements	Human contact for the organization.
Comments	The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-3: The telecom of an organization can never be of use 'home' `where(use = 'home').empty()`
Mappings	v2: ORC-22? rim: .telecom servd: ./ContactPoints
Organization.address
Definition	An address for the organization.
Cardinality	0...*
Type	Address
Must Support	True
Requirements	May need to keep track of the organization's addresses for contacting, billing or reporting requirements.
Comments	Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` org-2: An address of an organization can never be of use 'home' `where(use = 'home').empty()`
Mappings	v2: ORC-23? rim: .address servd: ./PrimaryAddress and ./OtherAddresses
Organization.partOf
Definition	The organization of which this organization forms a part.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Requirements	Need to be able to track the hierarchy of organizations within an organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: No equivalent in HL7 v2 rim: .playedBy[classCode=Part].scoper servd: n/a
Organization.contact
Definition	Contact for the organization for a certain purpose.
Cardinality	0...*
Type	BackboneElement
Requirements	Need to keep track of assigned contact points within bigger organization.
Comments	Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .contactParty
Organization.contact.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
Mappings	rim: n/a
Organization.contact.extension
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.
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.
Invariants	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
Organization.contact.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Organization.contact.purpose
Definition	Indicates a purpose for which the contact can be reached.
Cardinality	0...1
Type	CodeableConcept
Binding	The purpose for which you would contact a contact party. ContactEntityType (extensible)
Requirements	Need to distinguish between multiple contact persons.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: ./type
Organization.contact.name
Definition	A name associated with the contact.
Cardinality	0...1
Type	HumanName
Requirements	Need to be able to track the person by name.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PID-5, PID-9 rim: ./name
Organization.contact.telecom
Definition	A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
Cardinality	0...*
Type	ContactPoint
Requirements	People have (primary) ways to contact them in some way such as phone, email.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PID-13, PID-14 rim: ./telecom
Organization.contact.address
Definition	Visiting or postal addresses for the contact.
Cardinality	0...1
Type	Address
Requirements	May need to keep track of a contact party's address for contacting, billing or reporting requirements.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PID-11 rim: ./addr
Organization.endpoint
Definition	Technical endpoints providing access to services operated for the organization.
Cardinality	0...*
Type	Reference(Endpoint)
Requirements	Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a

Organization		..
Organization.extension	Extension	..
Organization.extension	Extension	..
Organization.extension.value[x]		..
Organization.identifier		..
Organization.identifier		..1
Organization.identifier.system		1..
Organization.identifier.value		1..
Organization.identifier		..1
Organization.identifier.system		1..
Organization.identifier.value		1..
Organization.active		..
Organization.type		..
Organization.name		..
Organization.telecom		..
Organization.address		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Organization" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
    <version value="2.5.0" />
    <name value="UKCoreOrganization" />
    <title value="UK Core Organization" />
    <status value="active" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Organization](https://hl7.org/fhir/R4/Organization.html)." />
    <purpose value="This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Organization" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Organization" />
    <derivation value="constraint" />
    <differential>
        <element id="Organization.extension:mainLocation">
            <path value="Organization.extension" />
            <sliceName value="mainLocation" />
            <short value="The main location of the organisation." />
            <definition value="The main location of the organisation." />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation" />
            </type>
        </element>
        <element id="Organization.extension:organizationPeriod">
            <path value="Organization.extension" />
            <sliceName value="organizationPeriod" />
            <short value="The date range that this organization SHOULD be considered available." />
            <definition value="The date range that this organization SHOULD be considered available." />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/organization-period" />
            </type>
        </element>
        <element id="Organization.extension:organizationPeriod.value[x]">
            <path value="Organization.extension.value[x]" />
            <short value="The date range that this organization SHOULD be considered available." />
            <definition value="The date range that this organization SHOULD be considered available." />
        </element>
        <element id="Organization.identifier">
            <path value="Organization.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
            <short value="Identifies this organization across multiple systems." />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:odsOrganisationCode">
            <path value="Organization.identifier" />
            <sliceName value="odsOrganisationCode" />
            <short value="Organisation Data Service code" />
            <definition value="Identifier code supplier by the Organisation Data Service." />
            <max value="1" />
        </element>
        <element id="Organization.identifier:odsOrganisationCode.system">
            <path value="Organization.identifier.system" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/ods-organization-code" />
        </element>
        <element id="Organization.identifier:odsOrganisationCode.value">
            <path value="Organization.identifier.value" />
            <min value="1" />
        </element>
        <element id="Organization.identifier:odsSiteCode">
            <path value="Organization.identifier" />
            <sliceName value="odsSiteCode" />
            <short value="ODS Site code to identify the organisation at site level" />
            <definition value="ODS Site code to identify the organisation at site level." />
            <max value="1" />
        </element>
        <element id="Organization.identifier:odsSiteCode.system">
            <path value="Organization.identifier.system" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/ods-site-code" />
        </element>
        <element id="Organization.identifier:odsSiteCode.value">
            <path value="Organization.identifier.value" />
            <min value="1" />
        </element>
        <element id="Organization.active">
            <path value="Organization.active" />
            <short value="Identifies this organization across multiple systems." />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type">
            <path value="Organization.type" />
            <binding>
                <strength value="extensible" />
                <description value="A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType" />
            </binding>
        </element>
        <element id="Organization.name">
            <path value="Organization.name" />
            <short value="A name associated with the organization." />
            <mustSupport value="true" />
        </element>
        <element id="Organization.telecom">
            <path value="Organization.telecom" />
            <short value="Contact details for the organization." />
            <mustSupport value="true" />
        </element>
        <element id="Organization.address">
            <path value="Organization.address" />
            <short value="An address for the organization." />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Organization",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
    "version": "2.5.0",
    "name": "UKCoreOrganization",
    "title": "UK Core Organization",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Organization](https://hl7.org/fhir/R4/Organization.html).",
    "purpose": "This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "Organization",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Organization.extension:mainLocation",
                "path": "Organization.extension",
                "sliceName": "mainLocation",
                "short": "The main location of the organisation.",
                "definition": "The main location of the organisation.",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.extension:organizationPeriod",
                "path": "Organization.extension",
                "sliceName": "organizationPeriod",
                "short": "The date range that this organization SHOULD be considered available.",
                "definition": "The date range that this organization SHOULD be considered available.",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/organization-period"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.extension:organizationPeriod.value[x]",
                "path": "Organization.extension.value[x]",
                "short": "The date range that this organization SHOULD be considered available.",
                "definition": "The date range that this organization SHOULD be considered available."
            },
            {
                "id": "Organization.identifier",
                "path": "Organization.identifier",
                "short": "Identifies this organization across multiple systems.",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:odsOrganisationCode",
                "path": "Organization.identifier",
                "sliceName": "odsOrganisationCode",
                "short": "Organisation Data Service code",
                "definition": "Identifier code supplier by the Organisation Data Service.",
                "max": "1"
            },
            {
                "id": "Organization.identifier:odsOrganisationCode.system",
                "path": "Organization.identifier.system",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/ods-organization-code"
            },
            {
                "id": "Organization.identifier:odsOrganisationCode.value",
                "path": "Organization.identifier.value",
                "min": 1
            },
            {
                "id": "Organization.identifier:odsSiteCode",
                "path": "Organization.identifier",
                "sliceName": "odsSiteCode",
                "short": "ODS Site code to identify the organisation at site level",
                "definition": "ODS Site code to identify the organisation at site level.",
                "max": "1"
            },
            {
                "id": "Organization.identifier:odsSiteCode.system",
                "path": "Organization.identifier.system",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/ods-site-code"
            },
            {
                "id": "Organization.identifier:odsSiteCode.value",
                "path": "Organization.identifier.value",
                "min": 1
            },
            {
                "id": "Organization.active",
                "path": "Organization.active",
                "short": "Identifies this organization across multiple systems.",
                "mustSupport": true
            },
            {
                "id": "Organization.type",
                "path": "Organization.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType"
                }
            },
            {
                "id": "Organization.name",
                "path": "Organization.name",
                "short": "A name associated with the organization.",
                "mustSupport": true
            },
            {
                "id": "Organization.telecom",
                "path": "Organization.telecom",
                "short": "Contact details for the organization.",
                "mustSupport": true
            },
            {
                "id": "Organization.address",
                "path": "Organization.address",
                "short": "An address for the organization.",
                "mustSupport": true
            }
        ]
    }
}

Examples

1. An example to illustrate an organization

Example UKCore-Organization-WhiteRoseMedicalCentre

2. An example to illustrate an NHS Trust organisation

Example UKCore-Organization-LeedsTeachingHospital

Propose a change to UK Core Organization

StructureDefinition UKCore-OrganizationAffiliation

UKCoreOrganizationAffiliation (OrganizationAffiliation)	I		OrganizationAffiliation	There are no (further) constraints on this element Element id OrganizationAffiliation Short description Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship Definition Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship. Data type OrganizationAffiliation Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act rim: Role
id	Σ	0..1	string	There are no (further) constraints on this element Element id OrganizationAffiliation.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id OrganizationAffiliation.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id OrganizationAffiliation.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id OrganizationAffiliation.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id OrganizationAffiliation.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id OrganizationAffiliation.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id OrganizationAffiliation.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id OrganizationAffiliation.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id OrganizationAffiliation.identifier Short description Business identifiers that are specific to this role Definition Business identifiers that are specific to this role. Requirements Often, specific identities are assigned for the agent. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier rim: .id
active	S Σ	0..1	boolean	There are no (further) constraints on this element Element id OrganizationAffiliation.active Short description Whether this organization affiliation record is in active use Definition Whether this organization affiliation record is in active use. Requirements Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use. Comments If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: .statusCode
period	Σ	0..1	Period	There are no (further) constraints on this element Element id OrganizationAffiliation.period Short description The period during which the participatingOrganization is affiliated with the primary organization Definition The period during which the participatingOrganization is affiliated with the primary organization. Requirements An affiliation may be created ahead of time and only be active for a defined period of time. Once the affiliation is complete, the fact that it existed may still be required. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.done[x] rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
organization	S Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id OrganizationAffiliation.organization Short description Organization where the role is available Definition Organization where the role is available (primary organization/has members). Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .scoper
participatingOrganization	S Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id OrganizationAffiliation.participatingOrganization Short description Organization that provides/performs the role (e.g. providing services or is a member of) Definition The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of). Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .player
network	Σ	0..*	Reference(Organization)	There are no (further) constraints on this element Element id OrganizationAffiliation.network Short description Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) Definition Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
code	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element id OrganizationAffiliation.code Short description Definition of the role the participatingOrganization plays Definition Definition of the role the participatingOrganization plays in the association. Data type CodeableConcept Binding The role the participating organization providing services to the primary organization. OrganizationAffiliationRole (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .code
specialty	Σ	0..*	CodeableConceptBinding	Element id OrganizationAffiliation.specialty Short description Specific specialty of the participatingOrganization in the context of the role Definition Specific specialty of the participatingOrganization in the context of the role. Data type CodeableConcept Binding Specific specialty associated with the participating organization. UKCorePracticeSettingCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .player.HealthCareProvider[@classCode = 'PROV'].code
location	Σ	0..*	Reference(Location)	There are no (further) constraints on this element Element id OrganizationAffiliation.location Short description The location(s) at which the role occurs Definition The location(s) at which the role occurs. Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.where[x] rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
healthcareService		0..*	Reference(HealthcareService)	There are no (further) constraints on this element Element id OrganizationAffiliation.healthcareService Short description Healthcare services provided through the role Definition Healthcare services provided through the role. Data type Reference(HealthcareService) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .player.QualifiedEntity[@classCode = 'QUAL'].code
telecom	Σ	0..*	ContactPoint	There are no (further) constraints on this element Element id OrganizationAffiliation.telecom Short description Contact details at the participatingOrganization relevant to this Affiliation Definition Contact details at the participatingOrganization relevant to this Affiliation. Requirements Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .telecom
endpoint		0..*	Reference(Endpoint)	There are no (further) constraints on this element Element id OrganizationAffiliation.endpoint Short description Technical endpoints providing access to services operated for this role Definition Technical endpoints providing access to services operated for this role. Data type Reference(Endpoint) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

OrganizationAffiliation
Definition	Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act rim: Role
OrganizationAffiliation.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
OrganizationAffiliation.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
OrganizationAffiliation.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
OrganizationAffiliation.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
OrganizationAffiliation.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
OrganizationAffiliation.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
OrganizationAffiliation.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
OrganizationAffiliation.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
OrganizationAffiliation.identifier
Definition	Business identifiers that are specific to this role.
Cardinality	0...*
Type	Identifier
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier rim: .id
OrganizationAffiliation.active
Definition	Whether this organization affiliation record is in active use.
Cardinality	0...1
Type	boolean
Must Support	True
Summary	True
Requirements	Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.
Comments	If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status rim: .statusCode
OrganizationAffiliation.period
Definition	The period during which the participatingOrganization is affiliated with the primary organization.
Cardinality	0...1
Type	Period
Summary	True
Requirements	An affiliation may be created ahead of time and only be active for a defined period of time. Once the affiliation is complete, the fact that it existed may still be required.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.done[x] rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
OrganizationAffiliation.organization
Definition	Organization where the role is available (primary organization/has members).
Cardinality	0...1
Type	Reference(Organization)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .scoper
OrganizationAffiliation.participatingOrganization
Definition	The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).
Cardinality	0...1
Type	Reference(Organization)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .player
OrganizationAffiliation.network
Definition	Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).
Cardinality	0...*
Type	Reference(Organization)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
OrganizationAffiliation.code
Definition	Definition of the role the participatingOrganization plays in the association.
Cardinality	0...*
Type	CodeableConcept
Binding	The role the participating organization providing services to the primary organization. OrganizationAffiliationRole (example)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .code
OrganizationAffiliation.specialty
Definition	Specific specialty of the participatingOrganization in the context of the role.
Cardinality	0...*
Type	CodeableConcept
Binding	Specific specialty associated with the participating organization. UKCorePracticeSettingCode (extensible)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .player.HealthCareProvider[@classCode = 'PROV'].code
OrganizationAffiliation.location
Definition	The location(s) at which the role occurs.
Cardinality	0...*
Type	Reference(Location)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.where[x] rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
OrganizationAffiliation.healthcareService
Definition	Healthcare services provided through the role.
Cardinality	0...*
Type	Reference(HealthcareService)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .player.QualifiedEntity[@classCode = 'QUAL'].code
OrganizationAffiliation.telecom
Definition	Contact details at the participatingOrganization relevant to this Affiliation.
Cardinality	0...*
Type	ContactPoint
Summary	True
Requirements	Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .telecom
OrganizationAffiliation.endpoint
Definition	Technical endpoints providing access to services operated for this role.
Cardinality	0...*
Type	Reference(Endpoint)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a

OrganizationAffiliation		..
OrganizationAffiliation.active		..
OrganizationAffiliation.organization		..
OrganizationAffiliation.participatingOrganization		..
OrganizationAffiliation.specialty		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-OrganizationAffiliation" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-OrganizationAffiliation" />
    <version value="0.0.1" />
    <name value="UKCoreOrganizationAffiliation" />
    <title value="UK Core OrganizationAffiliation" />
    <status value="draft" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [OrganizationAffiliation](https://hl7.org/fhir/R4/OrganizationAffiliation.html)." />
    <purpose value="The purpose of this profile is to hold information about relationships between different organizations." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="OrganizationAffiliation" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation" />
    <derivation value="constraint" />
    <differential>
        <element id="OrganizationAffiliation.active">
            <path value="OrganizationAffiliation.active" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.organization">
            <path value="OrganizationAffiliation.organization" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.participatingOrganization">
            <path value="OrganizationAffiliation.participatingOrganization" />
            <mustSupport value="true" />
        </element>
        <element id="OrganizationAffiliation.specialty">
            <path value="OrganizationAffiliation.specialty" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-OrganizationAffiliation",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OrganizationAffiliation",
    "version": "0.0.1",
    "name": "UKCoreOrganizationAffiliation",
    "title": "UK Core OrganizationAffiliation",
    "status": "draft",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [OrganizationAffiliation](https://hl7.org/fhir/R4/OrganizationAffiliation.html).",
    "purpose": "The purpose of this profile is to hold information about relationships between different organizations.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "OrganizationAffiliation",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "OrganizationAffiliation.active",
                "path": "OrganizationAffiliation.active",
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.organization",
                "path": "OrganizationAffiliation.organization",
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.participatingOrganization",
                "path": "OrganizationAffiliation.participatingOrganization",
                "mustSupport": true
            },
            {
                "id": "OrganizationAffiliation.specialty",
                "path": "OrganizationAffiliation.specialty",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode"
                }
            }
        ]
    }
}

Propose a change to UK Core Organization Affiliation

StructureDefinition UKCore-Practitioner

UKCorePractitioner (Practitioner)	I		Practitioner	There are no (further) constraints on this element Element id Practitioner Short description A person with a formal responsibility in the provisioning of healthcare or related services Definition A person who is directly or indirectly involved in the provisioning of healthcare. Data type Practitioner Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: Provider
id	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Practitioner.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Practitioner.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Practitioner.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Practitioner.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	S Σ	0..*	Identifier	Element id Practitioner.identifier Short description An identifier that applies to this person in this role. Definition An identifier that applies to this person in this role. Requirements Often, specific identities are assigned for the agent. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers
active	Σ	0..1	boolean	There are no (further) constraints on this element Element id Practitioner.active Short description Whether this practitioner's record is in active use Definition Whether this practitioner's record is in active use. Requirements Need to be able to mark a practitioner record as not to be used because it was created in error. Comments If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: ./statusCode
name	S Σ	0..*	HumanName	Element id Practitioner.name Short description The name(s) associated with the practitioner. Definition The name(s) associated with the practitioner. Requirements The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. Comments The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XCN Components rim: ./name servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
telecom	S Σ	0..*	ContactPoint	Element id Practitioner.telecom Short description A contact detail for the practitioner (that apply to all roles). Definition A contact detail for the practitioner, e.g. a telephone number or an email address. Requirements Need to know how to reach a practitioner independent to any roles the practitioner may have. Comments Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PRT-15, STF-10, ROL-12 rim: ./telecom servd: ./ContactPoints
address	Σ	0..*	Address	There are no (further) constraints on this element Element id Practitioner.address Short description Address(es) of the practitioner that are not role specific (typically home address) Definition Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. Requirements The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Comments The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: ORC-24, STF-11, ROL-11, PRT-14 rim: ./addr servd: ./Addresses
gender	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Data type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: STF-5 rim: ./administrativeGender servd: ./GenderCode
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element id Practitioner.birthDate Short description The date on which the practitioner was born Definition The date of birth for the practitioner. Requirements Needed for identification. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: STF-6 rim: ./birthTime servd: (not represented in ServD)
photo		0..*	Attachment	There are no (further) constraints on this element Element id Practitioner.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. Data type Attachment Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./subjectOf/ObservationEvent[code="photo"]/value servd: ./ImageURI (only supports the URI reference)
qualification		0..*	BackboneElement	There are no (further) constraints on this element Element id Practitioner.qualification Short description Certification, licenses, or training pertaining to the provision of care Definition The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CER? rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.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 Practitioner.qualification.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.qualification.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier		0..*	Identifier	There are no (further) constraints on this element Element id Practitioner.qualification.identifier Short description An identifier for this qualification for the practitioner Definition An identifier that applies to this person's qualification in this role. Requirements Often, specific identities are assigned for the qualification. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].id
code		1..1	CodeableConcept	There are no (further) constraints on this element Element id Practitioner.qualification.code Short description Coded representation of the qualification Definition Coded representation of the qualification. Data type CodeableConcept Binding Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications.Value
period		0..1	Period	There are no (further) constraints on this element Element id Practitioner.qualification.period Short description Period during which the qualification is valid Definition Period during which the qualification is valid. Requirements Qualifications are often for a limited period of time, and can be revoked. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime servd: ./Qualifications.StartDate and ./Qualifications.EndDate
issuer		0..1	Reference(Organization)	There are no (further) constraints on this element Element id Practitioner.qualification.issuer Short description Organization that regulates and issues the qualification Definition Organization that regulates and issues the qualification. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].scoper
communication		0..*	CodeableConceptBinding	Element id Practitioner.communication Short description A language the practitioner can use in patient communication Definition A language the practitioner can use in patient communication. Requirements Knowing which language a practitioner speaks can help in facilitating communication with patients. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data type CodeableConcept Binding A ValueSet that identifies the language used by a person. AllLanguages (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-15, NK1-20, LAN-2 rim: ./languageCommunication servd: ./Languages.LanguageSpokenCode

Practitioner
Definition	A person who is directly or indirectly involved in the provisioning of healthcare.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: Provider
Practitioner.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Practitioner.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
Practitioner.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
Practitioner.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
Practitioner.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Practitioner.identifier
Definition	An identifier that applies to this person in this role.
Cardinality	0...*
Type	Identifier
Must Support	True
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers
Practitioner.active
Definition	Whether this practitioner's record is in active use.
Cardinality	0...1
Type	boolean
Summary	True
Requirements	Need to be able to mark a practitioner record as not to be used because it was created in error.
Comments	If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status rim: ./statusCode
Practitioner.name
Definition	The name(s) associated with the practitioner.
Cardinality	0...*
Type	HumanName
Must Support	True
Summary	True
Requirements	The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
Comments	The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XCN Components rim: ./name servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
Practitioner.telecom
Definition	A contact detail for the practitioner, e.g. a telephone number or an email address.
Cardinality	0...*
Type	ContactPoint
Must Support	True
Summary	True
Requirements	Need to know how to reach a practitioner independent to any roles the practitioner may have.
Comments	Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PRT-15, STF-10, ROL-12 rim: ./telecom servd: ./ContactPoints
Practitioner.address
Definition	Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
Cardinality	0...*
Type	Address
Summary	True
Requirements	The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.
Comments	The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: ORC-24, STF-11, ROL-11, PRT-14 rim: ./addr servd: ./Addresses
Practitioner.gender
Definition	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Cardinality	0...1
Type	code
Binding	The gender of a person used for administrative purposes. AdministrativeGender (required)
Summary	True
Requirements	Needed to address the person correctly.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: STF-5 rim: ./administrativeGender servd: ./GenderCode
Practitioner.birthDate
Definition	The date of birth for the practitioner.
Cardinality	0...1
Type	date
Summary	True
Requirements	Needed for identification.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: STF-6 rim: ./birthTime servd: (not represented in ServD)
Practitioner.photo
Definition	Image of the person.
Cardinality	0...*
Type	Attachment
Requirements	Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: ./subjectOf/ObservationEvent[code="photo"]/value servd: ./ImageURI (only supports the URI reference)
Practitioner.qualification
Definition	The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
Cardinality	0...*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CER? rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications
Practitioner.qualification.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
Mappings	rim: n/a
Practitioner.qualification.extension
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.
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.
Invariants	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
Practitioner.qualification.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Practitioner.qualification.identifier
Definition	An identifier that applies to this person's qualification in this role.
Cardinality	0...*
Type	Identifier
Requirements	Often, specific identities are assigned for the qualification.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].id
Practitioner.qualification.code
Definition	Coded representation of the qualification.
Cardinality	1...1
Type	CodeableConcept
Binding	Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications.Value
Practitioner.qualification.period
Definition	Period during which the qualification is valid.
Cardinality	0...1
Type	Period
Requirements	Qualifications are often for a limited period of time, and can be revoked.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime servd: ./Qualifications.StartDate and ./Qualifications.EndDate
Practitioner.qualification.issuer
Definition	Organization that regulates and issues the qualification.
Cardinality	0...1
Type	Reference(Organization)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].scoper
Practitioner.communication
Definition	A language the practitioner can use in patient communication.
Cardinality	0...*
Type	CodeableConcept
Binding	A ValueSet that identifies the language used by a person. AllLanguages (required)
Requirements	Knowing which language a practitioner speaks can help in facilitating communication with patients.
Comments	The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PID-15, NK1-20, LAN-2 rim: ./languageCommunication servd: ./Languages.LanguageSpokenCode

Practitioner		..
Practitioner.identifier		..
Practitioner.name		..
Practitioner.telecom		..
Practitioner.communication		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Practitioner" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
    <version value="2.4.0" />
    <name value="UKCorePractitioner" />
    <title value="UK Core Practitioner" />
    <status value="active" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Practitioner](https://hl7.org/fhir/R4/Practitioner.html)." />
    <purpose value="This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities, is used for attribution of activities and responsibilities to these individuals." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Practitioner" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
    <derivation value="constraint" />
    <differential>
        <element id="Practitioner.identifier">
            <path value="Practitioner.identifier" />
            <short value="An identifier that applies to this person in this role." />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.name">
            <path value="Practitioner.name" />
            <short value="The name(s) associated with the practitioner." />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.telecom">
            <path value="Practitioner.telecom" />
            <short value="A contact detail for the practitioner (that apply to all roles)." />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.communication">
            <path value="Practitioner.communication" />
            <binding>
                <strength value="required" />
                <description value="A ValueSet that identifies the language used by a person." />
                <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Practitioner",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
    "version": "2.4.0",
    "name": "UKCorePractitioner",
    "title": "UK Core Practitioner",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Practitioner](https://hl7.org/fhir/R4/Practitioner.html).",
    "purpose": "This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities, is used for attribution of activities and responsibilities to these individuals.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "Practitioner",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Practitioner.identifier",
                "path": "Practitioner.identifier",
                "short": "An identifier that applies to this person in this role.",
                "mustSupport": true
            },
            {
                "id": "Practitioner.name",
                "path": "Practitioner.name",
                "short": "The name(s) associated with the practitioner.",
                "mustSupport": true
            },
            {
                "id": "Practitioner.telecom",
                "path": "Practitioner.telecom",
                "short": "A contact detail for the practitioner (that apply to all roles).",
                "mustSupport": true
            },
            {
                "id": "Practitioner.communication",
                "path": "Practitioner.communication",
                "binding": {
                    "strength": "required",
                    "description": "A ValueSet that identifies the language used by a person.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
                }
            }
        ]
    }
}

Examples

1. General Practitioner - An example to illustrate a practitioner who is the Patient's GP.

Example UKCore-Practitioner-DoctorPaulRastall

2. Consultant - An example to illustrate a practitioner who is a Consultant.

Example UKCore-Practitioner-ConsultantSandraGose

3. Pharmacist - An example to illustrate a practitioner who is a Pharmacist.

Example UKCore-Practitioner-PharmacistJimmyChuck

Propose a change to UK Core Practitioner

StructureDefinition UKCore-PractitionerRole

UKCorePractitioner (Practitioner)	I		Practitioner	There are no (further) constraints on this element Element id Practitioner Short description A person with a formal responsibility in the provisioning of healthcare or related services Definition A person who is directly or indirectly involved in the provisioning of healthcare. Data type Practitioner Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: Provider
id	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Practitioner.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Practitioner.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Practitioner.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Practitioner.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	S Σ	0..*	Identifier	Element id Practitioner.identifier Short description An identifier that applies to this person in this role. Definition An identifier that applies to this person in this role. Requirements Often, specific identities are assigned for the agent. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers
active	Σ	0..1	boolean	There are no (further) constraints on this element Element id Practitioner.active Short description Whether this practitioner's record is in active use Definition Whether this practitioner's record is in active use. Requirements Need to be able to mark a practitioner record as not to be used because it was created in error. Comments If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: ./statusCode
name	S Σ	0..*	HumanName	Element id Practitioner.name Short description The name(s) associated with the practitioner. Definition The name(s) associated with the practitioner. Requirements The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. Comments The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XCN Components rim: ./name servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
telecom	S Σ	0..*	ContactPoint	Element id Practitioner.telecom Short description A contact detail for the practitioner (that apply to all roles). Definition A contact detail for the practitioner, e.g. a telephone number or an email address. Requirements Need to know how to reach a practitioner independent to any roles the practitioner may have. Comments Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PRT-15, STF-10, ROL-12 rim: ./telecom servd: ./ContactPoints
address	Σ	0..*	Address	There are no (further) constraints on this element Element id Practitioner.address Short description Address(es) of the practitioner that are not role specific (typically home address) Definition Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. Requirements The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Comments The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: ORC-24, STF-11, ROL-11, PRT-14 rim: ./addr servd: ./Addresses
gender	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Data type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: STF-5 rim: ./administrativeGender servd: ./GenderCode
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element id Practitioner.birthDate Short description The date on which the practitioner was born Definition The date of birth for the practitioner. Requirements Needed for identification. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: STF-6 rim: ./birthTime servd: (not represented in ServD)
photo		0..*	Attachment	There are no (further) constraints on this element Element id Practitioner.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. Data type Attachment Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./subjectOf/ObservationEvent[code="photo"]/value servd: ./ImageURI (only supports the URI reference)
qualification		0..*	BackboneElement	There are no (further) constraints on this element Element id Practitioner.qualification Short description Certification, licenses, or training pertaining to the provision of care Definition The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CER? rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.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 Practitioner.qualification.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.qualification.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier		0..*	Identifier	There are no (further) constraints on this element Element id Practitioner.qualification.identifier Short description An identifier for this qualification for the practitioner Definition An identifier that applies to this person's qualification in this role. Requirements Often, specific identities are assigned for the qualification. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].id
code		1..1	CodeableConcept	There are no (further) constraints on this element Element id Practitioner.qualification.code Short description Coded representation of the qualification Definition Coded representation of the qualification. Data type CodeableConcept Binding Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications.Value
period		0..1	Period	There are no (further) constraints on this element Element id Practitioner.qualification.period Short description Period during which the qualification is valid Definition Period during which the qualification is valid. Requirements Qualifications are often for a limited period of time, and can be revoked. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime servd: ./Qualifications.StartDate and ./Qualifications.EndDate
issuer		0..1	Reference(Organization)	There are no (further) constraints on this element Element id Practitioner.qualification.issuer Short description Organization that regulates and issues the qualification Definition Organization that regulates and issues the qualification. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].scoper
communication		0..*	CodeableConceptBinding	Element id Practitioner.communication Short description A language the practitioner can use in patient communication Definition A language the practitioner can use in patient communication. Requirements Knowing which language a practitioner speaks can help in facilitating communication with patients. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data type CodeableConcept Binding A ValueSet that identifies the language used by a person. AllLanguages (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-15, NK1-20, LAN-2 rim: ./languageCommunication servd: ./Languages.LanguageSpokenCode

Practitioner
Definition	A person who is directly or indirectly involved in the provisioning of healthcare.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: Provider
Practitioner.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Practitioner.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
Practitioner.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
Practitioner.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
Practitioner.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Practitioner.identifier
Definition	An identifier that applies to this person in this role.
Cardinality	0...*
Type	Identifier
Must Support	True
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers
Practitioner.active
Definition	Whether this practitioner's record is in active use.
Cardinality	0...1
Type	boolean
Summary	True
Requirements	Need to be able to mark a practitioner record as not to be used because it was created in error.
Comments	If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status rim: ./statusCode
Practitioner.name
Definition	The name(s) associated with the practitioner.
Cardinality	0...*
Type	HumanName
Must Support	True
Summary	True
Requirements	The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
Comments	The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XCN Components rim: ./name servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
Practitioner.telecom
Definition	A contact detail for the practitioner, e.g. a telephone number or an email address.
Cardinality	0...*
Type	ContactPoint
Must Support	True
Summary	True
Requirements	Need to know how to reach a practitioner independent to any roles the practitioner may have.
Comments	Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PRT-15, STF-10, ROL-12 rim: ./telecom servd: ./ContactPoints
Practitioner.address
Definition	Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
Cardinality	0...*
Type	Address
Summary	True
Requirements	The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.
Comments	The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: ORC-24, STF-11, ROL-11, PRT-14 rim: ./addr servd: ./Addresses
Practitioner.gender
Definition	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Cardinality	0...1
Type	code
Binding	The gender of a person used for administrative purposes. AdministrativeGender (required)
Summary	True
Requirements	Needed to address the person correctly.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: STF-5 rim: ./administrativeGender servd: ./GenderCode
Practitioner.birthDate
Definition	The date of birth for the practitioner.
Cardinality	0...1
Type	date
Summary	True
Requirements	Needed for identification.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: STF-6 rim: ./birthTime servd: (not represented in ServD)
Practitioner.photo
Definition	Image of the person.
Cardinality	0...*
Type	Attachment
Requirements	Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: ./subjectOf/ObservationEvent[code="photo"]/value servd: ./ImageURI (only supports the URI reference)
Practitioner.qualification
Definition	The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
Cardinality	0...*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CER? rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications
Practitioner.qualification.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
Mappings	rim: n/a
Practitioner.qualification.extension
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.
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.
Invariants	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
Practitioner.qualification.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Practitioner.qualification.identifier
Definition	An identifier that applies to this person's qualification in this role.
Cardinality	0...*
Type	Identifier
Requirements	Often, specific identities are assigned for the qualification.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].id
Practitioner.qualification.code
Definition	Coded representation of the qualification.
Cardinality	1...1
Type	CodeableConcept
Binding	Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications.Value
Practitioner.qualification.period
Definition	Period during which the qualification is valid.
Cardinality	0...1
Type	Period
Requirements	Qualifications are often for a limited period of time, and can be revoked.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime servd: ./Qualifications.StartDate and ./Qualifications.EndDate
Practitioner.qualification.issuer
Definition	Organization that regulates and issues the qualification.
Cardinality	0...1
Type	Reference(Organization)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].scoper
Practitioner.communication
Definition	A language the practitioner can use in patient communication.
Cardinality	0...*
Type	CodeableConcept
Binding	A ValueSet that identifies the language used by a person. AllLanguages (required)
Requirements	Knowing which language a practitioner speaks can help in facilitating communication with patients.
Comments	The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PID-15, NK1-20, LAN-2 rim: ./languageCommunication servd: ./Languages.LanguageSpokenCode

Practitioner		..
Practitioner.identifier		..
Practitioner.name		..
Practitioner.telecom		..
Practitioner.communication		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Practitioner" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
    <version value="2.4.0" />
    <name value="UKCorePractitioner" />
    <title value="UK Core Practitioner" />
    <status value="active" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Practitioner](https://hl7.org/fhir/R4/Practitioner.html)." />
    <purpose value="This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities, is used for attribution of activities and responsibilities to these individuals." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Practitioner" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
    <derivation value="constraint" />
    <differential>
        <element id="Practitioner.identifier">
            <path value="Practitioner.identifier" />
            <short value="An identifier that applies to this person in this role." />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.name">
            <path value="Practitioner.name" />
            <short value="The name(s) associated with the practitioner." />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.telecom">
            <path value="Practitioner.telecom" />
            <short value="A contact detail for the practitioner (that apply to all roles)." />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.communication">
            <path value="Practitioner.communication" />
            <binding>
                <strength value="required" />
                <description value="A ValueSet that identifies the language used by a person." />
                <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Practitioner",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
    "version": "2.4.0",
    "name": "UKCorePractitioner",
    "title": "UK Core Practitioner",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Practitioner](https://hl7.org/fhir/R4/Practitioner.html).",
    "purpose": "This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities, is used for attribution of activities and responsibilities to these individuals.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "Practitioner",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Practitioner.identifier",
                "path": "Practitioner.identifier",
                "short": "An identifier that applies to this person in this role.",
                "mustSupport": true
            },
            {
                "id": "Practitioner.name",
                "path": "Practitioner.name",
                "short": "The name(s) associated with the practitioner.",
                "mustSupport": true
            },
            {
                "id": "Practitioner.telecom",
                "path": "Practitioner.telecom",
                "short": "A contact detail for the practitioner (that apply to all roles).",
                "mustSupport": true
            },
            {
                "id": "Practitioner.communication",
                "path": "Practitioner.communication",
                "binding": {
                    "strength": "required",
                    "description": "A ValueSet that identifies the language used by a person.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
                }
            }
        ]
    }
}

Examples

Patient's GP - An example to illustrate the role of General Practitioner.

Example UKCore-PractitionerRole-GP

Propose a change to UK Core Practitioner Role

StructureDefinition UKCore-Questionnaire

UKCoreQuestionnaire (Questionnaire)	I		Questionnaire	There are no (further) constraints on this element Element id Questionnaire Short description A structured set of questions Alternate names Form, CRF, Survey Definition A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection. Data type Questionnaire Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')` que-2: The link ids for groups and questions must be unique within the questionnaire `descendants().linkId.isDistinct()` Mappings rim: Entity. Role, or Act workflow: Definition rim: Observation[moodCode=DEF]
id	Σ	0..1	string	There are no (further) constraints on this element Element id Questionnaire.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Questionnaire.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Questionnaire.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Questionnaire.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Questionnaire.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Questionnaire.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Questionnaire.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Questionnaire.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
url	S Σ	0..1	uri	There are no (further) constraints on this element Element id Questionnaire.url Short description Canonical identifier for this questionnaire, represented as a URI (globally unique) Definition An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers. Requirements … This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for. Comments The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.url w5: FiveWs.identifier rim: .identifier[scope=BUSN;reliability=ISS]
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id Questionnaire.identifier Short description Additional identifier for the questionnaire Definition A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. Requirements Allows externally provided and/or usable business identifiers to be easily associated with the module. Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.identifier w5: FiveWs.identifier rim: .identifier objimpl: no-gen-base
version	Σ	0..1	string	There are no (further) constraints on this element Element id Questionnaire.version Short description Business version of the questionnaire Definition The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. Comments There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format [url]\|[version]. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.version w5: FiveWs.version rim: N/A (to add?)
name	Σ I	0..1	string	There are no (further) constraints on this element Element id Questionnaire.name Short description Name for this questionnaire (computer friendly) Definition A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. Requirements Support human navigation and code generation. Comments The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. 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
title	S Σ	0..1	string	There are no (further) constraints on this element Element id Questionnaire.title Short description Name for this questionnaire (human friendly) Definition A short, descriptive, user-friendly title for the questionnaire. Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.title rim: .title
derivedFrom		0..*	canonical(Questionnaire)	There are no (further) constraints on this element Element id Questionnaire.derivedFrom Short description Instantiates protocol or definition Definition The URL of a Questionnaire that this Questionnaire is based on. Requirements Allows a Questionnaire to be created based on another Questionnaire. Data type canonical(Questionnaire) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.derivedFrom rim: .outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]
status	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element id Questionnaire.status Short description draft \| active \| retired \| unknown Definition The status of this questionnaire. Enables tracking the life-cycle of the content. Comments Allows filtering of questionnaires that are appropriate for use versus not. Data type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.status w5: FiveWs.status rim: .status
experimental	Σ	0..1	boolean	There are no (further) constraints on this element Element id Questionnaire.experimental Short description For testing purposes, not real usage Definition A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire. Comments Allows filtering of questionnaires that are appropriate for use versus not. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.experimental w5: FiveWs.class rim: N/A
subjectType	S Σ	0..*	codeBinding	There are no (further) constraints on this element Element id Questionnaire.subjectType Short description Resource that can be subject of QuestionnaireResponse Definition The types of subjects that can be the subject of responses created for the questionnaire. Comments If none are specified, then the subject is unlimited. Data type code Binding One of the resource types defined as part of this version of FHIR. ResourceType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.subject[x] rim: .outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode
date	Σ	0..1	dateTime	There are no (further) constraints on this element Element id Questionnaire.date Short description Date last changed Alternate names Revision Date Definition The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.date w5: FiveWs.recorded rim: .participation[typeCode=AUT].time
publisher	Σ	0..1	string	There are no (further) constraints on this element Element id Questionnaire.publisher Short description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the questionnaire. Requirements Helps establish the "authority/credibility" of the questionnaire. May also allow for contact. Comments Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.publisher w5: FiveWs.witness rim: .participation[typeCode=AUT].role
contact	Σ	0..*	ContactDetail	There are no (further) constraints on this element Element id Questionnaire.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. Data type ContactDetail Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.contact rim: .participation[typeCode=CALLBCK].role
description		0..1	markdown	There are no (further) constraints on this element Element id Questionnaire.description Short description Natural language description of the questionnaire Definition A free text natural language description of the questionnaire from a consumer's perspective. Comments This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created). Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.description rim: .text
useContext	Σ	0..*	UsageContext	There are no (further) constraints on this element Element id Questionnaire.useContext Short description The context that the content is intended to support Definition The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances. Requirements Assist in searching for appropriate content. Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. Data type UsageContext Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.useContext rim: N/A (to add?)
jurisdiction	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Questionnaire.jurisdiction Short description Intended jurisdiction for questionnaire (if applicable) Definition A legal or geographic region in which the questionnaire is intended to be used. Comments It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended. Data type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.jurisdiction rim: N/A (to add?)
purpose		0..1	markdown	There are no (further) constraints on this element Element id Questionnaire.purpose Short description Why this questionnaire is defined Definition Explanation of why this questionnaire is needed and why it has been designed as it has. Comments This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire. Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.purpose w5: FiveWs.why[x] rim: .reasonCode.text objimpl: no-gen-base
copyright		0..1	markdown	There are no (further) constraints on this element Element id Questionnaire.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions Definition A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. Requirements Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content. Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.copyright rim: N/A (to add?) objimpl: no-gen-base
approvalDate		0..1	date	There are no (further) constraints on this element Element id Questionnaire.approvalDate Short description When the questionnaire was approved by publisher Definition The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. Comments The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.approvalDate rim: .outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime objimpl: no-gen-base
lastReviewDate		0..1	date	There are no (further) constraints on this element Element id Questionnaire.lastReviewDate Short description When the questionnaire was last reviewed Definition The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. Requirements Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. Comments If specified, this date follows the original approval date. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.lastReviewDate rim: .outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime objimpl: no-gen-base
effectivePeriod	Σ	0..1	Period	There are no (further) constraints on this element Element id Questionnaire.effectivePeriod Short description When the questionnaire is expected to be used Definition The period during which the questionnaire content was or is planned to be in active use. Requirements Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead. Comments The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Definition.effectivePeriod rim: N/A (to add?) objimpl: no-gen-base
code	Σ	0..*	CodingBinding	Element id Questionnaire.code Short description Concept that represents the overall questionnaire Definition An identifier for this question or group of questions in a particular terminology such as LOINC. Requirements Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code. Data type Coding Binding A set of codes that define questions or groups of questions, consisting of the entirety of the SNOMED CT UK Coding System. This set of codes may not necessarily be complete or appropriate and may require further discussion in the future. UKCoreQuestionnaireQuestionCodes (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .code
item	S I	0..*	BackboneElement	There are no (further) constraints on this element Element id Questionnaire.item Short description Questions and sections within the Questionnaire Definition A particular question, question grouping or display text that is part of the questionnaire. Comments The content of the questionnaire is constructed from an ordered, hierarchical collection of items. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` que-1: Group items must have nested items, display items cannot have nested items `(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())` que-3: Display items cannot have a "code" asserted `type!='display' or code.empty()` que-4: A question cannot have both answerOption and answerValueSet `answerOption.empty() or answerValueSet.empty()` que-5: Only 'choice' and 'open-choice' items can have answerValueSet `(type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())` que-6: Required and repeat aren't permitted for display items `type!='display' or (required.empty() and repeats.empty())` que-8: Initial values can't be specified for groups or display items `(type!='group' and type!='display') or initial.empty()` que-9: Read-only can't be specified for "display" items `type!='display' or readOnly.empty()` que-10: Maximum length can only be declared for simple question types `(type in ('boolean' \| 'decimal' \| 'integer' \| 'string' \| 'text' \| 'url' \| 'open-choice')) or maxLength.empty()` que-11: If one or more answerOption is present, initial[x] must be missing `answerOption.empty() or initial.empty()` que-12: If there are more than one enableWhen, enableBehavior must be specified `enableWhen.count() > 2 implies enableBehavior.exists()` que-13: Can only have multiple initial values for repeating items `repeats=true or initial.count() <= 1` Mappings rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]
id		0..1	string	There are no (further) constraints on this element Element id Questionnaire.item.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 Questionnaire.item.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Questionnaire.item.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
linkId	S	1..1	string	There are no (further) constraints on this element Element id Questionnaire.item.linkId Short description Unique id for item in questionnaire Definition An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. Requirements QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient. Comments This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .id
definition		0..1	uri	There are no (further) constraints on this element Element id Questionnaire.item.definition Short description ElementDefinition - details for the item Definition This element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value: code (ElementDefinition.code) type (ElementDefinition.type) required (ElementDefinition.min) repeats (ElementDefinition.max) maxLength (ElementDefinition.maxLength) answerValueSet (ElementDefinition.binding) options (ElementDefinition.binding). Requirements A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition. Comments The uri refers to an ElementDefinition in a StructureDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id Element.id. E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]
code	I	0..*	Coding	There are no (further) constraints on this element Element id Questionnaire.item.code Short description Corresponding concept for this item in a terminology Definition A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). Requirements Allows linking of groups of questions to formal terminologies. Comments The value may come from the ElementDefinition referred to by .definition. Data type Coding Binding Codes for questionnaires, groups and individual questions. QuestionnaireQuestionCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .code
prefix		0..1	string	There are no (further) constraints on this element Element id Questionnaire.item.prefix Short description E.g. "1(a)", "2.5.3" Alternate names label Definition A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire. Requirements Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used. Comments These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for "display" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Not supported
text	S	0..1	string	There are no (further) constraints on this element Element id Questionnaire.item.text Short description Primary text for the item Definition The name of a section, the text of a question or text content for a display item. Comments When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .text
type	S	1..1	codeBinding	There are no (further) constraints on this element Element id Questionnaire.item.type Short description group \| display \| boolean \| decimal \| integer \| date \| dateTime + Definition The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.). Requirements Defines the format in which the user is to be prompted for the answer. Comments Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition. Data type code Binding Distinguishes groups from questions and display text and indicates data type for questions. QuestionnaireItemType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A - MIF rather than RIM level
enableWhen	?! I	0..*	BackboneElement	There are no (further) constraints on this element Element id Questionnaire.item.enableWhen Short description Only allow data when Definition A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. Requirements Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions. Comments If multiple repetitions of this extension are present, the item should be enabled when the condition for any of the repetitions is true. I.e. treat "enableWhen"s as being joined by an "or" clause. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` que-7: If the operator is 'exists', the value must be a boolean `operator = 'exists' implies (answer is Boolean)` Mappings rim: N/A - MIF rather than RIM level
id		0..1	string	There are no (further) constraints on this element Element id Questionnaire.item.enableWhen.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 Questionnaire.item.enableWhen.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Questionnaire.item.enableWhen.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
question		1..1	string	There are no (further) constraints on this element Element id Questionnaire.item.enableWhen.question Short description Question that determines whether item is enabled Definition The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. Comments If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis. 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 - MIF rather than RIM level
operator		1..1	codeBinding	There are no (further) constraints on this element Element id Questionnaire.item.enableWhen.operator Short description exists \| = \| != \| > \| < \| >= \| <= Definition Specifies the criteria by which the question is enabled. Data type code Binding The criteria by which a question is enabled. QuestionnaireItemOperator (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A - MIF rather than RIM level
answer[x]	I	1..1		There are no (further) constraints on this element Element id Questionnaire.item.enableWhen.answer[x] Short description Value for question comparison based on operator Definition A value that the referenced question is tested using the specified operator in order for the item to be enabled. Binding Allowed values to answer questions. QuestionnaireAnswerCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A - MIF rather than RIM level
answerBoolean			boolean	There are no (further) constraints on this element Data type boolean
answerDecimal			decimal	There are no (further) constraints on this element Data type decimal
answerInteger			integer	There are no (further) constraints on this element Data type integer
answerDate			date	There are no (further) constraints on this element Data type date
answerDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
answerTime			time	There are no (further) constraints on this element Data type time
answerString			string	There are no (further) constraints on this element Data type string
answerCoding			Coding	There are no (further) constraints on this element Data type Coding
answerQuantity			Quantity	There are no (further) constraints on this element Data type Quantity
answerReference			Reference(Resource)	There are no (further) constraints on this element Data type Reference(Resource)
enableBehavior	I	0..1	codeBinding	There are no (further) constraints on this element Element id Questionnaire.item.enableBehavior Short description all \| any Definition Controls how multiple enableWhen values are interpreted - whether all or any must be true. Comments This element must be specified if more than one enableWhen value is provided. Data type code Binding Controls how multiple enableWhen values are interpreted - whether all or any must be true. EnableWhenBehavior (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A - MIF rather than RIM level
required	I	0..1	boolean	There are no (further) constraints on this element Element id Questionnaire.item.required Short description Whether the item must be included in data results Definition An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire. Comments Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition. Meaning when missing Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value 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 - MIF rather than RIM level
repeats	I	0..1	boolean	There are no (further) constraints on this element Element id Questionnaire.item.repeats Short description Whether the item may repeat Definition An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups. Requirements Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. Comments If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items. The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values. The value may come from the ElementDefinition referred to by .definition. Meaning when missing Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value 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 - MIF rather than RIM level
readOnly	I	0..1	boolean	There are no (further) constraints on this element Element id Questionnaire.item.readOnly Short description Don't allow human editing Definition An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. Requirements Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc. Comments The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers. 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 - MIF rather than RIM level
maxLength	I	0..1	integer	There are no (further) constraints on this element Element id Questionnaire.item.maxLength Short description No more than this many characters Definition The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. Comments For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition. Data type integer Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: N/A - MIF rather than RIM level
answerValueSet	I	0..1	canonical(ValueSet)	There are no (further) constraints on this element Element id Questionnaire.item.answerValueSet Short description Valueset containing permitted answers Definition A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question. Comments LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition. Data type canonical(ValueSet) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A - MIF rather than RIM level
answerOption	I	0..*	BackboneElement	There are no (further) constraints on this element Element id Questionnaire.item.answerOption Short description Permitted answer Definition One of the permitted answers for a "choice" or "open-choice" question. Comments This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A - MIF rather than RIM level
id		0..1	string	There are no (further) constraints on this element Element id Questionnaire.item.answerOption.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 Questionnaire.item.answerOption.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Questionnaire.item.answerOption.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
value[x]		1..1		There are no (further) constraints on this element Element id Questionnaire.item.answerOption.value[x] Short description Answer value Definition A potential answer that's allowed as the answer to this question. Comments The data type of the value must agree with the item.type. Binding Allowed values to answer questions. QuestionnaireAnswerCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A - MIF rather than RIM level
valueInteger			integer	There are no (further) constraints on this element Data type integer
valueDate			date	There are no (further) constraints on this element Data type date
valueTime			time	There are no (further) constraints on this element Data type time
valueString			string	There are no (further) constraints on this element Data type string
valueCoding			Coding	There are no (further) constraints on this element Data type Coding
valueReference			Reference(Resource)	There are no (further) constraints on this element Data type Reference(Resource)
initialSelected		0..1	boolean	There are no (further) constraints on this element Element id Questionnaire.item.answerOption.initialSelected Short description Whether option is selected by default Definition Indicates whether the answer value is selected when the list of possible answers is initially shown. Comments Use this instead of initial[v] if answerValueSet is present. Meaning when missing Only selected items explicitly marked to be selected 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 - MIF rather than RIM level
initial	I	0..*	BackboneElement	There are no (further) constraints on this element Element id Questionnaire.item.initial Short description Initial value(s) when item is first rendered Definition One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. Requirements In some workflows, having defaults saves time. Comments The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A - MIF rather than RIM level
id		0..1	string	There are no (further) constraints on this element Element id Questionnaire.item.initial.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 Questionnaire.item.initial.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Questionnaire.item.initial.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
value[x]		1..1		There are no (further) constraints on this element Element id Questionnaire.item.initial.value[x] Short description Actual value for initializing the question Definition The actual value to for an initial answer. Comments The type of the initial value must be consistent with the type of the item. Binding Allowed values to answer questions. QuestionnaireAnswerCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A - MIF rather than RIM level
valueBoolean			boolean	There are no (further) constraints on this element Data type boolean
valueDecimal			decimal	There are no (further) constraints on this element Data type decimal
valueInteger			integer	There are no (further) constraints on this element Data type integer
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
valueTime			time	There are no (further) constraints on this element Data type time
valueString			string	There are no (further) constraints on this element Data type string
valueUri			uri	There are no (further) constraints on this element Data type uri
valueAttachment			Attachment	There are no (further) constraints on this element Data type Attachment
valueCoding			Coding	There are no (further) constraints on this element Data type Coding
valueQuantity			Quantity	There are no (further) constraints on this element Data type Quantity
valueReference			Reference(Resource)	There are no (further) constraints on this element Data type Reference(Resource)
item	I	0..*	see (item)	There are no (further) constraints on this element Element id Questionnaire.item.item Short description Nested questionnaire items Definition Text, questions and other groups to be nested beneath a question or group. Requirements Reports can consist of complex nested groups. Comments There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .outboundRelationship[typeCode=COMP].target

Questionnaire
Definition	A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
Cardinality	0...*
Alias	Form, CRF, Survey
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')` que-2: The link ids for groups and questions must be unique within the questionnaire `descendants().linkId.isDistinct()`
Mappings	rim: Entity. Role, or Act workflow: Definition rim: Observation[moodCode=DEF]
Questionnaire.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Questionnaire.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Questionnaire.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Questionnaire.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Questionnaire.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
Questionnaire.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
Questionnaire.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
Questionnaire.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Questionnaire.url
Definition	An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.
Cardinality	0...1
Type	uri
Must Support	True
Summary	True
Requirements	… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.
Comments	The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.url w5: FiveWs.identifier rim: .identifier[scope=BUSN;reliability=ISS]
Questionnaire.identifier
Definition	A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
Cardinality	0...*
Type	Identifier
Summary	True
Requirements	Allows externally provided and/or usable business identifiers to be easily associated with the module.
Comments	Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.identifier w5: FiveWs.identifier rim: .identifier objimpl: no-gen-base
Questionnaire.version
Definition	The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Cardinality	0...1
Type	string
Summary	True
Comments	There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format [url]\|[version].
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.version w5: FiveWs.version rim: N/A (to add?)
Questionnaire.name
Definition	A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Cardinality	0...1
Type	string
Summary	True
Requirements	Support human navigation and code generation.
Comments	The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
Questionnaire.title
Definition	A short, descriptive, user-friendly title for the questionnaire.
Cardinality	0...1
Type	string
Must Support	True
Summary	True
Comments	This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.title rim: .title
Questionnaire.derivedFrom
Definition	The URL of a Questionnaire that this Questionnaire is based on.
Cardinality	0...*
Type	canonical(Questionnaire)
Requirements	Allows a Questionnaire to be created based on another Questionnaire.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.derivedFrom rim: .outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]
Questionnaire.status
Definition	The status of this questionnaire. Enables tracking the life-cycle of the content.
Cardinality	1...1
Type	code
Binding	The lifecycle status of an artifact. PublicationStatus (required)
Must Support	True
Modifier	True
Summary	True
Comments	Allows filtering of questionnaires that are appropriate for use versus not.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.status w5: FiveWs.status rim: .status
Questionnaire.experimental
Definition	A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Cardinality	0...1
Type	boolean
Summary	True
Requirements	Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.
Comments	Allows filtering of questionnaires that are appropriate for use versus not.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.experimental w5: FiveWs.class rim: N/A
Questionnaire.subjectType
Definition	The types of subjects that can be the subject of responses created for the questionnaire.
Cardinality	0...*
Type	code
Binding	One of the resource types defined as part of this version of FHIR. ResourceType (required)
Must Support	True
Summary	True
Comments	If none are specified, then the subject is unlimited.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.subject[x] rim: .outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode
Questionnaire.date
Definition	The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.
Cardinality	0...1
Type	dateTime
Summary	True
Alias	Revision Date
Comments	Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.date w5: FiveWs.recorded rim: .participation[typeCode=AUT].time
Questionnaire.publisher
Definition	The name of the organization or individual that published the questionnaire.
Cardinality	0...1
Type	string
Summary	True
Requirements	Helps establish the "authority/credibility" of the questionnaire. May also allow for contact.
Comments	Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.publisher w5: FiveWs.witness rim: .participation[typeCode=AUT].role
Questionnaire.contact
Definition	Contact details to assist a user in finding and communicating with the publisher.
Cardinality	0...*
Type	ContactDetail
Summary	True
Comments	May be a web site, an email address, a telephone number, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.contact rim: .participation[typeCode=CALLBCK].role
Questionnaire.description
Definition	A free text natural language description of the questionnaire from a consumer's perspective.
Cardinality	0...1
Type	markdown
Comments	This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.description rim: .text
Questionnaire.useContext
Definition	The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.
Cardinality	0...*
Type	UsageContext
Summary	True
Requirements	Assist in searching for appropriate content.
Comments	When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.useContext rim: N/A (to add?)
Questionnaire.jurisdiction
Definition	A legal or geographic region in which the questionnaire is intended to be used.
Cardinality	0...*
Type	CodeableConcept
Binding	Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible)
Summary	True
Comments	It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.jurisdiction rim: N/A (to add?)
Questionnaire.purpose
Definition	Explanation of why this questionnaire is needed and why it has been designed as it has.
Cardinality	0...1
Type	markdown
Comments	This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.purpose w5: FiveWs.why[x] rim: .reasonCode.text objimpl: no-gen-base
Questionnaire.copyright
Definition	A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
Cardinality	0...1
Type	markdown
Alias	License, Restrictions
Requirements	Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.copyright rim: N/A (to add?) objimpl: no-gen-base
Questionnaire.approvalDate
Definition	The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Cardinality	0...1
Type	date
Comments	The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.approvalDate rim: .outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime objimpl: no-gen-base
Questionnaire.lastReviewDate
Definition	The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Cardinality	0...1
Type	date
Requirements	Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
Comments	If specified, this date follows the original approval date.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.lastReviewDate rim: .outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime objimpl: no-gen-base
Questionnaire.effectivePeriod
Definition	The period during which the questionnaire content was or is planned to be in active use.
Cardinality	0...1
Type	Period
Summary	True
Requirements	Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead.
Comments	The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Definition.effectivePeriod rim: N/A (to add?) objimpl: no-gen-base
Questionnaire.code
Definition	An identifier for this question or group of questions in a particular terminology such as LOINC.
Cardinality	0...*
Type	Coding
Binding	A set of codes that define questions or groups of questions, consisting of the entirety of the SNOMED CT UK Coding System. This set of codes may not necessarily be complete or appropriate and may require further discussion in the future. UKCoreQuestionnaireQuestionCodes (preferred)
Summary	True
Requirements	Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .code
Questionnaire.item
Definition	A particular question, question grouping or display text that is part of the questionnaire.
Cardinality	0...*
Type	BackboneElement
Must Support	True
Comments	The content of the questionnaire is constructed from an ordered, hierarchical collection of items.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` que-1: Group items must have nested items, display items cannot have nested items `(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())` que-3: Display items cannot have a "code" asserted `type!='display' or code.empty()` que-4: A question cannot have both answerOption and answerValueSet `answerOption.empty() or answerValueSet.empty()` que-5: Only 'choice' and 'open-choice' items can have answerValueSet `(type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())` que-6: Required and repeat aren't permitted for display items `type!='display' or (required.empty() and repeats.empty())` que-8: Initial values can't be specified for groups or display items `(type!='group' and type!='display') or initial.empty()` que-9: Read-only can't be specified for "display" items `type!='display' or readOnly.empty()` que-10: Maximum length can only be declared for simple question types `(type in ('boolean' \| 'decimal' \| 'integer' \| 'string' \| 'text' \| 'url' \| 'open-choice')) or maxLength.empty()` que-11: If one or more answerOption is present, initial[x] must be missing `answerOption.empty() or initial.empty()` que-12: If there are more than one enableWhen, enableBehavior must be specified `enableWhen.count() > 2 implies enableBehavior.exists()` que-13: Can only have multiple initial values for repeating items `repeats=true or initial.count() <= 1`
Mappings	rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]
Questionnaire.item.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
Mappings	rim: n/a
Questionnaire.item.extension
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.
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.
Invariants	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
Questionnaire.item.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Questionnaire.item.linkId
Definition	An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
Cardinality	1...1
Type	string
Must Support	True
Requirements	QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.
Comments	This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .id
Questionnaire.item.definition
Definition	This element is a URI that refers to an [ElementDefinition](elementdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value: * code (ElementDefinition.code) * type (ElementDefinition.type) * required (ElementDefinition.min) * repeats (ElementDefinition.max) * maxLength (ElementDefinition.maxLength) * answerValueSet (ElementDefinition.binding) * options (ElementDefinition.binding).
Cardinality	0...1
Type	uri
Requirements	A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.
Comments	The uri refers to an ElementDefinition in a StructureDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id Element.id. E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]
Questionnaire.item.code
Definition	A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
Cardinality	0...*
Type	Coding
Binding	Codes for questionnaires, groups and individual questions. QuestionnaireQuestionCodes (example)
Requirements	Allows linking of groups of questions to formal terminologies.
Comments	The value may come from the ElementDefinition referred to by .definition.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .code
Questionnaire.item.prefix
Definition	A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.
Cardinality	0...1
Type	string
Alias	label
Requirements	Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.
Comments	These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for "display" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Not supported
Questionnaire.item.text
Definition	The name of a section, the text of a question or text content for a display item.
Cardinality	0...1
Type	string
Must Support	True
Comments	When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .text
Questionnaire.item.type
Definition	The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).
Cardinality	1...1
Type	code
Binding	Distinguishes groups from questions and display text and indicates data type for questions. QuestionnaireItemType (required)
Must Support	True
Requirements	Defines the format in which the user is to be prompted for the answer.
Comments	Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.enableWhen
Definition	A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
Cardinality	0...*
Type	BackboneElement
Modifier	True
Requirements	Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.
Comments	If multiple repetitions of this extension are present, the item should be enabled when the condition for any of the repetitions is true. I.e. treat "enableWhen"s as being joined by an "or" clause. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` que-7: If the operator is 'exists', the value must be a boolean `operator = 'exists' implies (answer is Boolean)`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.enableWhen.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
Mappings	rim: n/a
Questionnaire.item.enableWhen.extension
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.
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.
Invariants	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
Questionnaire.item.enableWhen.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Questionnaire.item.enableWhen.question
Definition	The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.
Cardinality	1...1
Type	string
Comments	If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.enableWhen.operator
Definition	Specifies the criteria by which the question is enabled.
Cardinality	1...1
Type	code
Binding	The criteria by which a question is enabled. QuestionnaireItemOperator (required)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.enableWhen.answer[x]
Definition	A value that the referenced question is tested using the specified operator in order for the item to be enabled.
Cardinality	1...1
Type	boolean
Binding	Allowed values to answer questions. QuestionnaireAnswerCodes (example)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.enableBehavior
Definition	Controls how multiple enableWhen values are interpreted - whether all or any must be true.
Cardinality	0...1
Type	code
Binding	Controls how multiple enableWhen values are interpreted - whether all or any must be true. EnableWhenBehavior (required)
Comments	This element must be specified if more than one enableWhen value is provided.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.required
Definition	An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.
Cardinality	0...1
Type	boolean
Comments	Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.repeats
Definition	An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.
Cardinality	0...1
Type	boolean
Requirements	Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.
Comments	If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items. The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values. The value may come from the ElementDefinition referred to by .definition.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.readOnly
Definition	An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
Cardinality	0...1
Type	boolean
Requirements	Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.
Comments	The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.maxLength
Definition	The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.
Cardinality	0...1
Type	integer
Comments	For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: N/A rim: N/A - MIF rather than RIM level
Questionnaire.item.answerValueSet
Definition	A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.
Cardinality	0...1
Type	canonical(ValueSet)
Comments	LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.answerOption
Definition	One of the permitted answers for a "choice" or "open-choice" question.
Cardinality	0...*
Type	BackboneElement
Comments	This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.answerOption.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
Mappings	rim: n/a
Questionnaire.item.answerOption.extension
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.
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.
Invariants	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
Questionnaire.item.answerOption.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Questionnaire.item.answerOption.value[x]
Definition	A potential answer that's allowed as the answer to this question.
Cardinality	1...1
Type	integer
Binding	Allowed values to answer questions. QuestionnaireAnswerCodes (example)
Comments	The data type of the value must agree with the item.type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.answerOption.initialSelected
Definition	Indicates whether the answer value is selected when the list of possible answers is initially shown.
Cardinality	0...1
Type	boolean
Comments	Use this instead of initial[v] if answerValueSet is present.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.initial
Definition	One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.
Cardinality	0...*
Type	BackboneElement
Requirements	In some workflows, having defaults saves time.
Comments	The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.initial.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
Mappings	rim: n/a
Questionnaire.item.initial.extension
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.
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.
Invariants	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
Questionnaire.item.initial.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Questionnaire.item.initial.value[x]
Definition	The actual value to for an initial answer.
Cardinality	1...1
Type	boolean
Binding	Allowed values to answer questions. QuestionnaireAnswerCodes (example)
Comments	The type of the initial value must be consistent with the type of the item.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A - MIF rather than RIM level
Questionnaire.item.item
Definition	Text, questions and other groups to be nested beneath a question or group.
Cardinality	0...*
Type	see (item)
Requirements	Reports can consist of complex nested groups.
Comments	There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .outboundRelationship[typeCode=COMP].target

Questionnaire		..
Questionnaire.url		..
Questionnaire.title		..
Questionnaire.status		..
Questionnaire.subjectType		..
Questionnaire.code		..
Questionnaire.item		..
Questionnaire.item.linkId		..
Questionnaire.item.text		..
Questionnaire.item.type		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Questionnaire" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire" />
    <version value="1.3.0" />
    <name value="UKCoreQuestionnaire" />
    <title value="UK Core Questionnaire" />
    <status value="draft" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Questionnaire](https://hl7.org/fhir/R4/Questionnaire.html)." />
    <purpose value="This profile is used to organise a collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Questionnaire" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Questionnaire" />
    <derivation value="constraint" />
    <differential>
        <element id="Questionnaire.url">
            <path value="Questionnaire.url" />
            <mustSupport value="true" />
        </element>
        <element id="Questionnaire.title">
            <path value="Questionnaire.title" />
            <mustSupport value="true" />
        </element>
        <element id="Questionnaire.status">
            <path value="Questionnaire.status" />
            <mustSupport value="true" />
        </element>
        <element id="Questionnaire.subjectType">
            <path value="Questionnaire.subjectType" />
            <mustSupport value="true" />
        </element>
        <element id="Questionnaire.code">
            <path value="Questionnaire.code" />
            <binding>
                <strength value="preferred" />
                <description value="A set of codes that define questions or groups of questions, consisting of the entirety of the SNOMED CT UK Coding System. This set of codes may not necessarily be complete or appropriate and may require further discussion in the future." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-QuestionnaireQuestionCodes" />
            </binding>
        </element>
        <element id="Questionnaire.item">
            <path value="Questionnaire.item" />
            <mustSupport value="true" />
        </element>
        <element id="Questionnaire.item.linkId">
            <path value="Questionnaire.item.linkId" />
            <mustSupport value="true" />
        </element>
        <element id="Questionnaire.item.text">
            <path value="Questionnaire.item.text" />
            <mustSupport value="true" />
        </element>
        <element id="Questionnaire.item.type">
            <path value="Questionnaire.item.type" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Questionnaire",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Questionnaire",
    "version": "1.3.0",
    "name": "UKCoreQuestionnaire",
    "title": "UK Core Questionnaire",
    "status": "draft",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Questionnaire](https://hl7.org/fhir/R4/Questionnaire.html).",
    "purpose": "This profile is used to organise a collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "Questionnaire",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Questionnaire",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Questionnaire.url",
                "path": "Questionnaire.url",
                "mustSupport": true
            },
            {
                "id": "Questionnaire.title",
                "path": "Questionnaire.title",
                "mustSupport": true
            },
            {
                "id": "Questionnaire.status",
                "path": "Questionnaire.status",
                "mustSupport": true
            },
            {
                "id": "Questionnaire.subjectType",
                "path": "Questionnaire.subjectType",
                "mustSupport": true
            },
            {
                "id": "Questionnaire.code",
                "path": "Questionnaire.code",
                "binding": {
                    "strength": "preferred",
                    "description": "A set of codes that define questions or groups of questions, consisting of the entirety of the SNOMED CT UK Coding System. This set of codes may not necessarily be complete or appropriate and may require further discussion in the future.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-QuestionnaireQuestionCodes"
                }
            },
            {
                "id": "Questionnaire.item",
                "path": "Questionnaire.item",
                "mustSupport": true
            },
            {
                "id": "Questionnaire.item.linkId",
                "path": "Questionnaire.item.linkId",
                "mustSupport": true
            },
            {
                "id": "Questionnaire.item.text",
                "path": "Questionnaire.item.text",
                "mustSupport": true
            },
            {
                "id": "Questionnaire.item.type",
                "path": "Questionnaire.item.type",
                "mustSupport": true
            }
        ]
    }
}

Propose a change to UK Core Questionnaire

StructureDefinition UKCore-QuestionnaireResponse

UKCoreQuestionnaireResponse (QuestionnaireResponse)	I		QuestionnaireResponse	There are no (further) constraints on this element Element id QuestionnaireResponse Short description A structured set of questions and their answers Alternate names Form, QuestionnaireAnswers Definition A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to. Comments The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse. Data type QuestionnaireResponse Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act workflow: Event rim: Observation[moodCode=EVN]
id	Σ	0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id QuestionnaireResponse.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id QuestionnaireResponse.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id QuestionnaireResponse.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id QuestionnaireResponse.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id QuestionnaireResponse.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	S Σ	0..1	Identifier	There are no (further) constraints on this element Element id QuestionnaireResponse.identifier Short description Unique id for this set of answers Definition A business identifier assigned to a particular completed (or partially completed) questionnaire. Requirements Used for tracking, registration and other business purposes. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.identifier w5: FiveWs.identifier rim: .id
basedOn	Σ	0..*	Reference(CarePlan \| ServiceRequest)	There are no (further) constraints on this element Element id QuestionnaireResponse.basedOn Short description Request fulfilled by this QuestionnaireResponse Alternate names order Definition The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. Requirements Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon. Data type Reference(CarePlan \| ServiceRequest) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.basedOn rim: .outboundRelationship[typeCode=FLFS].target
partOf	Σ	0..*	Reference(Observation \| Procedure)	There are no (further) constraints on this element Element id QuestionnaireResponse.partOf Short description Part of this action Definition A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. Comments Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn. Data type Reference(Observation \| Procedure) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.partOf rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]
questionnaire	S Σ	0..1	canonical(Questionnaire)	There are no (further) constraints on this element Element id QuestionnaireResponse.questionnaire Short description Form being answered Alternate names Form Definition The Questionnaire that defines and organizes the questions for which answers are being provided. Requirements Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form. Comments If a QuestionnaireResponse references a Questionnaire, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.). Data type canonical(Questionnaire) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.instantiates rim: ./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]
status	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element id QuestionnaireResponse.status Short description in-progress \| completed \| amended \| entered-in-error \| stopped Definition The position of the questionnaire response within its overall lifecycle. Requirements The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished. Comments This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Data type code Binding Lifecycle status of the questionnaire response. QuestionnaireResponseStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.status w5: FiveWs.status rim: .statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish "in-progress" from "published)
subject	S Σ	0..1	Reference(Resource)	There are no (further) constraints on this element Element id QuestionnaireResponse.subject Short description The subject of the questions Alternate names Patient, Focus Definition The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. Requirements Allows linking the answers to the individual the answers describe. May also affect access control. Comments If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.subject w5: FiveWs.subject[x] rim: .participation[typeCode=SBJ].role w5: FiveWs.subject
encounter	Σ	0..1	Reference(Encounter)	There are no (further) constraints on this element Element id QuestionnaireResponse.encounter Short description Encounter created as part of Definition The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. Requirements Provides context for the information that was captured. May also affect access control. Comments This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter. Data type Reference(Encounter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.encounter w5: FiveWs.context rim: .inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]
authored	S Σ	0..1	dateTime	There are no (further) constraints on this element Element id QuestionnaireResponse.authored Short description Date the answers were gathered Alternate names Date Created, Date published, Date Issued, Date updated Definition The date and/or time that this set of answers were last changed. Requirements Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers. Comments May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured. This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.occurrence[x] w5: FiveWs.recorded rim: .participation[typeCode=AUT].time
author	S Σ	0..1	Reference(Device \| Practitioner \| PractitionerRole \| Patient \| RelatedPerson \| Organization)	There are no (further) constraints on this element Element id QuestionnaireResponse.author Short description Person who received and recorded the answers Alternate names Laboratory, Service, Practitioner, Department, Company, Performer Definition Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. Requirements Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers. Comments Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated. Data type Reference(Device \| Practitioner \| PractitionerRole \| Patient \| RelatedPerson \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer w5: FiveWs.author rim: .participation[typeCode=AUT].role
source	Σ	0..1	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson)	There are no (further) constraints on this element Element id QuestionnaireResponse.source Short description The person who answered the questions Definition The person who answered the questions about the subject. Requirements When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions. Comments If not specified, no inference can be made about who provided the data. Data type Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.source rim: .participation[typeCode=INF].role
item	S I	0..*	BackboneElement	There are no (further) constraints on this element Element id QuestionnaireResponse.item Short description Groups and questions Definition A group or question item from the original questionnaire for which answers are provided. Comments Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer). Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qrs-1: Nested item can't be beneath both item and answer `(answer.exists() and item.exists()).not()` Mappings rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]
id		0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.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 QuestionnaireResponse.item.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.item.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
linkId	S	1..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.linkId Short description Pointer to specific item from Questionnaire Definition The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource. Requirements Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id
definition		0..1	uri	There are no (further) constraints on this element Element id QuestionnaireResponse.item.definition Short description ElementDefinition - details for the item Definition A reference to an ElementDefinition that provides the details for the item. Requirements A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition. Comments The ElementDefinition must be in a StructureDefinition, and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. There is no need for this element if the item pointed to by the linkId has a definition listed. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code
text		0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.text Short description Name for group or question text Definition Text that is displayed above the contents of the group or as the text of the question being answered. Requirements Allows the questionnaire response to be read without access to the questionnaire. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .text
answer	S	0..*	BackboneElement	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer Short description The response(s) to the question Definition The respondent's answer(s) to the question. Comments The value is nested because we cannot have a repeating structure that has variable type. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .value[type=LIST_ANY]
id		0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.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 QuestionnaireResponse.item.answer.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
value[x]		0..1		There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x] Short description Single-valued answer to the question Definition The answer (or one of the answers) provided by the respondent to the question. Requirements Ability to retain a single-valued answer to a question. Comments More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Binding Code indicating the response provided for a question. QuestionnaireAnswerCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .item
valueBoolean			boolean	There are no (further) constraints on this element Data type boolean
valueDecimal			decimal	There are no (further) constraints on this element Data type decimal
valueInteger			integer	There are no (further) constraints on this element Data type integer
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
valueTime			time	There are no (further) constraints on this element Data type time
valueString			string	There are no (further) constraints on this element Data type string
valueUri			uri	There are no (further) constraints on this element Data type uri
valueAttachment			Attachment	There are no (further) constraints on this element Data type Attachment
valueCoding			Coding	There are no (further) constraints on this element Data type Coding
valueQuantity			Quantity	There are no (further) constraints on this element Data type Quantity
valueReference			Reference(Resource)	There are no (further) constraints on this element Data type Reference(Resource)
item		0..*	see (item)	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.item Short description Nested groups and questions Definition Nested groups and/or questions found within this particular answer. Requirements It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]
item		0..*	see (item)	There are no (further) constraints on this element Element id QuestionnaireResponse.item.item Short description Nested questionnaire response items Definition Questions or sub-groups nested beneath a question or group. Requirements Reports can consist of complex nested groups. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

QuestionnaireResponse
Definition	A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
Cardinality	0...*
Alias	Form, QuestionnaireAnswers
Comments	The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act workflow: Event rim: Observation[moodCode=EVN]
QuestionnaireResponse.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
QuestionnaireResponse.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
QuestionnaireResponse.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
QuestionnaireResponse.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
QuestionnaireResponse.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
QuestionnaireResponse.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
QuestionnaireResponse.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
QuestionnaireResponse.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
QuestionnaireResponse.identifier
Definition	A business identifier assigned to a particular completed (or partially completed) questionnaire.
Cardinality	0...1
Type	Identifier
Must Support	True
Summary	True
Requirements	Used for tracking, registration and other business purposes.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Event.identifier w5: FiveWs.identifier rim: .id
QuestionnaireResponse.basedOn
Definition	The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
Cardinality	0...*
Type	Reference(CarePlan \| ServiceRequest)
Summary	True
Alias	order
Requirements	Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Event.basedOn rim: .outboundRelationship[typeCode=FLFS].target
QuestionnaireResponse.partOf
Definition	A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.
Cardinality	0...*
Type	Reference(Observation \| Procedure)
Summary	True
Comments	Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Event.partOf rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]
QuestionnaireResponse.questionnaire
Definition	The Questionnaire that defines and organizes the questions for which answers are being provided.
Cardinality	0...1
Type	canonical(Questionnaire)
Must Support	True
Summary	True
Alias	Form
Requirements	Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form.
Comments	If a QuestionnaireResponse references a Questionnaire, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Event.instantiates rim: ./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]
QuestionnaireResponse.status
Definition	The position of the questionnaire response within its overall lifecycle.
Cardinality	1...1
Type	code
Binding	Lifecycle status of the questionnaire response. QuestionnaireResponseStatus (required)
Must Support	True
Modifier	True
Summary	True
Requirements	The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.
Comments	This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Event.status w5: FiveWs.status rim: .statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish "in-progress" from "published)
QuestionnaireResponse.subject
Definition	The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.
Cardinality	0...1
Type	Reference(Resource)
Must Support	True
Summary	True
Alias	Patient, Focus
Requirements	Allows linking the answers to the individual the answers describe. May also affect access control.
Comments	If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Event.subject w5: FiveWs.subject[x] rim: .participation[typeCode=SBJ].role w5: FiveWs.subject
QuestionnaireResponse.encounter
Definition	The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
Cardinality	0...1
Type	Reference(Encounter)
Summary	True
Requirements	Provides context for the information that was captured. May also affect access control.
Comments	This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Event.encounter w5: FiveWs.context rim: .inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]
QuestionnaireResponse.authored
Definition	The date and/or time that this set of answers were last changed.
Cardinality	0...1
Type	dateTime
Must Support	True
Summary	True
Alias	Date Created, Date published, Date Issued, Date updated
Requirements	Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.
Comments	May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured. This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Event.occurrence[x] w5: FiveWs.recorded rim: .participation[typeCode=AUT].time
QuestionnaireResponse.author
Definition	Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
Cardinality	0...1
Type	Reference(Device \| Practitioner \| PractitionerRole \| Patient \| RelatedPerson \| Organization)
Must Support	True
Summary	True
Alias	Laboratory, Service, Practitioner, Department, Company, Performer
Requirements	Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.
Comments	Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	workflow: Event.performer w5: FiveWs.author rim: .participation[typeCode=AUT].role
QuestionnaireResponse.source
Definition	The person who answered the questions about the subject.
Cardinality	0...1
Type	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson)
Summary	True
Requirements	When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions.
Comments	If not specified, no inference can be made about who provided the data.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.source rim: .participation[typeCode=INF].role
QuestionnaireResponse.item
Definition	A group or question item from the original questionnaire for which answers are provided.
Cardinality	0...*
Type	BackboneElement
Must Support	True
Comments	Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qrs-1: Nested item can't be beneath both item and answer `(answer.exists() and item.exists()).not()`
Mappings	rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]
QuestionnaireResponse.item.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
Mappings	rim: n/a
QuestionnaireResponse.item.extension
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.
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.
Invariants	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
QuestionnaireResponse.item.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
QuestionnaireResponse.item.linkId
Definition	The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.
Cardinality	1...1
Type	string
Must Support	True
Requirements	Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id
QuestionnaireResponse.item.definition
Definition	A reference to an [ElementDefinition](elementdefinition.html) that provides the details for the item.
Cardinality	0...1
Type	uri
Requirements	A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition.
Comments	The ElementDefinition must be in a StructureDefinition, and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. There is no need for this element if the item pointed to by the linkId has a definition listed.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code
QuestionnaireResponse.item.text
Definition	Text that is displayed above the contents of the group or as the text of the question being answered.
Cardinality	0...1
Type	string
Requirements	Allows the questionnaire response to be read without access to the questionnaire.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .text
QuestionnaireResponse.item.answer
Definition	The respondent's answer(s) to the question.
Cardinality	0...*
Type	BackboneElement
Must Support	True
Comments	The value is nested because we cannot have a repeating structure that has variable type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .value[type=LIST_ANY]
QuestionnaireResponse.item.answer.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
Mappings	rim: n/a
QuestionnaireResponse.item.answer.extension
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.
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.
Invariants	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
QuestionnaireResponse.item.answer.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
QuestionnaireResponse.item.answer.value[x]
Definition	The answer (or one of the answers) provided by the respondent to the question.
Cardinality	0...1
Type	boolean
Binding	Code indicating the response provided for a question. QuestionnaireAnswerCodes (example)
Requirements	Ability to retain a single-valued answer to a question.
Comments	More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .item
QuestionnaireResponse.item.answer.item
Definition	Nested groups and/or questions found within this particular answer.
Cardinality	0...*
Type	see (item)
Requirements	It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]
QuestionnaireResponse.item.item
Definition	Questions or sub-groups nested beneath a question or group.
Cardinality	0...*
Type	see (item)
Requirements	Reports can consist of complex nested groups.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

QuestionnaireResponse		..
QuestionnaireResponse.identifier		..
QuestionnaireResponse.questionnaire		..
QuestionnaireResponse.status		..
QuestionnaireResponse.subject		..
QuestionnaireResponse.authored		..
QuestionnaireResponse.author		..
QuestionnaireResponse.item		..
QuestionnaireResponse.item.linkId		..
QuestionnaireResponse.item.answer		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-QuestionnaireResponse" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse" />
    <version value="1.2.0" />
    <name value="UKCoreQuestionnaireResponse" />
    <title value="UK Core QuestionnaireResponse" />
    <status value="draft" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [QuestionnaireResponse](https://hl7.org/fhir/R4/QuestionnaireResponse.html)." />
    <purpose value="This profile describes a structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="QuestionnaireResponse" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" />
    <derivation value="constraint" />
    <differential>
        <element id="QuestionnaireResponse.identifier">
            <path value="QuestionnaireResponse.identifier" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.questionnaire">
            <path value="QuestionnaireResponse.questionnaire" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.status">
            <path value="QuestionnaireResponse.status" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.subject">
            <path value="QuestionnaireResponse.subject" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.authored">
            <path value="QuestionnaireResponse.authored" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.author">
            <path value="QuestionnaireResponse.author" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.item">
            <path value="QuestionnaireResponse.item" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.item.linkId">
            <path value="QuestionnaireResponse.item.linkId" />
            <mustSupport value="true" />
        </element>
        <element id="QuestionnaireResponse.item.answer">
            <path value="QuestionnaireResponse.item.answer" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-QuestionnaireResponse",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse",
    "version": "1.2.0",
    "name": "UKCoreQuestionnaireResponse",
    "title": "UK Core QuestionnaireResponse",
    "status": "draft",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [QuestionnaireResponse](https://hl7.org/fhir/R4/QuestionnaireResponse.html).",
    "purpose": "This profile describes a structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "QuestionnaireResponse",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "QuestionnaireResponse.identifier",
                "path": "QuestionnaireResponse.identifier",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.questionnaire",
                "path": "QuestionnaireResponse.questionnaire",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.status",
                "path": "QuestionnaireResponse.status",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.subject",
                "path": "QuestionnaireResponse.subject",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.authored",
                "path": "QuestionnaireResponse.authored",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.author",
                "path": "QuestionnaireResponse.author",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.item",
                "path": "QuestionnaireResponse.item",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.item.linkId",
                "path": "QuestionnaireResponse.item.linkId",
                "mustSupport": true
            },
            {
                "id": "QuestionnaireResponse.item.answer",
                "path": "QuestionnaireResponse.item.answer",
                "mustSupport": true
            }
        ]
    }
}

Propose a change to UK Core Questionnaire Response

StructureDefinition UKCore-Schedule

UKCoreSchedule (Schedule)	I		Schedule	There are no (further) constraints on this element Element id Schedule Short description A container for slots of time that may be available for booking appointments Alternate names Availability Definition A container for slots of time that may be available for booking appointments. Data type Schedule Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act rim: n/a ical: BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)
id	Σ	0..1	string	There are no (further) constraints on this element Element id Schedule.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Schedule.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Schedule.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Schedule.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Schedule.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Schedule.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Schedule.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Schedule.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id Schedule.identifier Short description External Ids for this item Definition External Ids for this item. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier ical: UID
active	S Σ ?!	0..1	boolean	Element id Schedule.active Short description Whether this schedule is in active use. Definition Whether this schedule record is in active use or should not be used (such as was entered in error). Comments This element is labeled as a modifier because it may be used to mark that the resource was created in error. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status
serviceCategory	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element id Schedule.serviceCategory Short description High-level category Definition A broad categorization of the service that is to be performed during this appointment. Data type CodeableConcept Binding ServiceCategory (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class
serviceType	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element id Schedule.serviceType Short description Specific service Definition The specific service that is to be performed during this appointment. Data type CodeableConcept Binding ServiceType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class ical: n/a
specialty	S Σ	0..*	CodeableConceptBinding	Element id Schedule.specialty Short description Type of specialty needed. Definition The specialty of a practitioner that would be required to perform the service requested in this appointment. Data type CodeableConcept Binding Additional details about where the content was created (e.g. clinical specialty). UKCorePracticeSettingCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class
actor	S Σ	1..*	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Device \| HealthcareService \| Location)	Element id Schedule.actor Short description Resource(s) that availability information is being provided for. Definition Slots that reference this schedule resource provide the availability details to these referenced resource(s). Comments The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system. Data type Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Device \| HealthcareService \| Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.subject[x] ical: ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource w5: FiveWs.subject
planningHorizon	S Σ	0..1	Period	Element id Schedule.planningHorizon Short description Period of time covered by schedule. Definition The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.planned ical: DTSTART:20131201T003000Z DTEND:2014030101T003000Z
comment		0..1	string	There are no (further) constraints on this element Element id Schedule.comment Short description Comments on availability Definition Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings ical: COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry

Schedule
Definition	A container for slots of time that may be available for booking appointments.
Cardinality	0...*
Alias	Availability
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act rim: n/a ical: BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)
Schedule.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Schedule.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Schedule.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Schedule.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Schedule.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
Schedule.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
Schedule.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
Schedule.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Schedule.identifier
Definition	External Ids for this item.
Cardinality	0...*
Type	Identifier
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier ical: UID
Schedule.active
Definition	Whether this schedule record is in active use or should not be used (such as was entered in error).
Cardinality	0...1
Type	boolean
Must Support	True
Modifier	True
Summary	True
Comments	This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status
Schedule.serviceCategory
Definition	A broad categorization of the service that is to be performed during this appointment.
Cardinality	0...*
Type	CodeableConcept
Binding	ServiceCategory (example)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class
Schedule.serviceType
Definition	The specific service that is to be performed during this appointment.
Cardinality	0...*
Type	CodeableConcept
Binding	ServiceType (example)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class ical: n/a
Schedule.specialty
Definition	The specialty of a practitioner that would be required to perform the service requested in this appointment.
Cardinality	0...*
Type	CodeableConcept
Binding	Additional details about where the content was created (e.g. clinical specialty). UKCorePracticeSettingCode (extensible)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class
Schedule.actor
Definition	Slots that reference this schedule resource provide the availability details to these referenced resource(s).
Cardinality	1...*
Type	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Device \| HealthcareService \| Location)
Must Support	True
Summary	True
Comments	The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.subject[x] ical: ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource w5: FiveWs.subject
Schedule.planningHorizon
Definition	The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
Cardinality	0...1
Type	Period
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.planned ical: DTSTART:20131201T003000Z DTEND:2014030101T003000Z
Schedule.comment
Definition	Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
Cardinality	0...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	ical: COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry

Schedule		..
Schedule.active		..
Schedule.specialty		..
Schedule.actor		..
Schedule.planningHorizon		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Schedule" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule" />
    <version value="1.3.0" />
    <name value="UKCoreSchedule" />
    <title value="UK Core Schedule" />
    <status value="active" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Schedule](https://hl7.org/fhir/R4/Schedule.html)." />
    <purpose value="Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.\n\nThe schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Schedule" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Schedule" />
    <derivation value="constraint" />
    <differential>
        <element id="Schedule.active">
            <path value="Schedule.active" />
            <short value="Whether this schedule is in active use." />
            <mustSupport value="true" />
        </element>
        <element id="Schedule.specialty">
            <path value="Schedule.specialty" />
            <short value="Type of specialty needed." />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" />
            </binding>
        </element>
        <element id="Schedule.actor">
            <path value="Schedule.actor" />
            <short value="Resource(s) that availability information is being provided for." />
            <mustSupport value="true" />
        </element>
        <element id="Schedule.planningHorizon">
            <path value="Schedule.planningHorizon" />
            <short value="Period of time covered by schedule." />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Schedule",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule",
    "version": "1.3.0",
    "name": "UKCoreSchedule",
    "title": "UK Core Schedule",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Schedule](https://hl7.org/fhir/R4/Schedule.html).",
    "purpose": "Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.\n\nThe schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "Schedule",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Schedule",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Schedule.active",
                "path": "Schedule.active",
                "short": "Whether this schedule is in active use.",
                "mustSupport": true
            },
            {
                "id": "Schedule.specialty",
                "path": "Schedule.specialty",
                "short": "Type of specialty needed.",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode"
                }
            },
            {
                "id": "Schedule.actor",
                "path": "Schedule.actor",
                "short": "Resource(s) that availability information is being provided for.",
                "mustSupport": true
            },
            {
                "id": "Schedule.planningHorizon",
                "path": "Schedule.planningHorizon",
                "short": "Period of time covered by schedule.",
                "mustSupport": true
            }
        ]
    }
}

Examples

An example to illustrate a schedule for immunization appointments

Example UKCore-Schedule-Immunization

Propose a change to UK Core Schedule

StructureDefinition UKCore-Slot

UKCoreSlot (Slot)	I		Slot	There are no (further) constraints on this element Element id Slot Short description A slot of time on a schedule that may be available for booking appointments Definition A slot of time on a schedule that may be available for booking appointments. Data type Slot Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act rim: n/a ical: (refer to the Availability resource for the header mapping details)
id	Σ	0..1	string	There are no (further) constraints on this element Element id Slot.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Slot.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Slot.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Slot.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Slot.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Slot.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	Element id Slot.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 resource. 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) 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
deliveryChannel	I	0..1	Extension(CodeableConcept)	Element id Slot.extension:deliveryChannel Short description This describes the delivery channel of a scheduled appointment. Alternate names extensions, user content Definition An extension to record the delivery channel of a scheduled Appointment. 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(CodeableConcept) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Slot.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id Slot.identifier Short description External Ids for this item Definition External Ids for this item. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier
serviceCategory	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element id Slot.serviceCategory Short description A broad categorization of the service that is to be performed during this appointment Definition A broad categorization of the service that is to be performed during this appointment. Data type CodeableConcept Binding ServiceCategory (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class
serviceType	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element id Slot.serviceType Short description The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource Definition The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource. Data type CodeableConcept Binding ServiceType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class
specialty	S Σ	0..*	CodeableConceptBinding	Element id Slot.specialty Short description The specialty of a practitioner that would be required to perform the service requested in this appointment. Definition The specialty of a practitioner that would be required to perform the service requested in this appointment. Data type CodeableConcept Binding Additional details about where the content was created (e.g. clinical specialty). UKCorePracticeSettingCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class
appointmentType	S Σ	0..1	CodeableConceptBinding	Element id Slot.appointmentType Short description The style of appointment or patient that may be booked in the slot. Definition The style of appointment or patient that may be booked in the slot (not service type). Data type CodeableConcept Binding v2.0276 (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class
schedule	S Σ	1..1	Reference(Schedule)	Element id Slot.schedule Short description A reference to the Schedule that this Slot is an interval of. Definition The schedule resource that this slot defines an interval of status information. Data type Reference(Schedule) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
status	S Σ	1..1	codeBinding	Element id Slot.status Short description The status of the slot, e.g free, busy, etc. Definition busy \| free \| busy-unavailable \| busy-tentative \| entered-in-error. Data type code Binding The free/busy status of the slot. SlotStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings ical: FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
start	S Σ	1..1	instant	Element id Slot.start Short description Date/Time that the slot is to begin. Definition Date/Time that the slot is to begin. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.planned ical: FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
end	S Σ	1..1	instant	Element id Slot.end Short description Date/Time that the slot is to conclude. Definition Date/Time that the slot is to conclude. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.planned ical: FREEBUSY:19980314T233000Z/(end) If the freeBusyType is BUSY, then this value can be excluded (as shown)
overbooked		0..1	boolean	There are no (further) constraints on this element Element id Slot.overbooked Short description This slot has already been overbooked, appointments are unlikely to be accepted for this time Definition This slot has already been overbooked, appointments are unlikely to be accepted for this time. Meaning when missing If overbooked is missing, systems may assume that there are still appointments available Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
comment		0..1	string	There are no (further) constraints on this element Element id Slot.comment Short description Comments on the slot to describe any extended information. Such as custom constraints on the slot Definition Comments on the slot to describe any extended information. Such as custom constraints on the slot. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

Slot
Definition	A slot of time on a schedule that may be available for booking appointments.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act rim: n/a ical: (refer to the Availability resource for the header mapping details)
Slot.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Slot.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Slot.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Slot.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Slot.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
Slot.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
Slot.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Slot.extension:deliveryChannel
Definition	An extension to record the delivery channel of a scheduled Appointment.
Cardinality	0...1
Type	Extension(CodeableConcept)
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() 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
Slot.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Slot.identifier
Definition	External Ids for this item.
Cardinality	0...*
Type	Identifier
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier
Slot.serviceCategory
Definition	A broad categorization of the service that is to be performed during this appointment.
Cardinality	0...*
Type	CodeableConcept
Binding	ServiceCategory (example)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class
Slot.serviceType
Definition	The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
Cardinality	0...*
Type	CodeableConcept
Binding	ServiceType (example)
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class
Slot.specialty
Definition	The specialty of a practitioner that would be required to perform the service requested in this appointment.
Cardinality	0...*
Type	CodeableConcept
Binding	Additional details about where the content was created (e.g. clinical specialty). UKCorePracticeSettingCode (extensible)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class
Slot.appointmentType
Definition	The style of appointment or patient that may be booked in the slot (not service type).
Cardinality	0...1
Type	CodeableConcept
Binding	v2.0276 (preferred)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.class
Slot.schedule
Definition	The schedule resource that this slot defines an interval of status information.
Cardinality	1...1
Type	Reference(Schedule)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Slot.status
Definition	busy \| free \| busy-unavailable \| busy-tentative \| entered-in-error.
Cardinality	1...1
Type	code
Binding	The free/busy status of the slot. SlotStatus (required)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	ical: FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
Slot.start
Definition	Date/Time that the slot is to begin.
Cardinality	1...1
Type	instant
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.planned ical: FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
Slot.end
Definition	Date/Time that the slot is to conclude.
Cardinality	1...1
Type	instant
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.planned ical: FREEBUSY:19980314T233000Z/(end) If the freeBusyType is BUSY, then this value can be excluded (as shown)
Slot.overbooked
Definition	This slot has already been overbooked, appointments are unlikely to be accepted for this time.
Cardinality	0...1
Type	boolean
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Slot.comment
Definition	Comments on the slot to describe any extended information. Such as custom constraints on the slot.
Cardinality	0...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

Slot		..
Slot.extension	Extension	..1
Slot.specialty		..
Slot.appointmentType		..
Slot.schedule		..
Slot.status		..
Slot.start		..
Slot.end		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Slot" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot" />
    <version value="1.3.0" />
    <name value="UKCoreSlot" />
    <title value="UK Core Slot" />
    <status value="active" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Slot](https://hl7.org/fhir/R4/Slot.html)." />
    <purpose value="Slot resources are used to provide time-slots that can be booked using an appointment. They do not provide any information about appointments that are available, just the time, and optionally what the time can be used for. These are effectively spaces of free/busy time.\nSlots can also be marked as busy without having appointments associated." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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  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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Slot" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Slot" />
    <derivation value="constraint" />
    <differential>
        <element id="Slot.extension:deliveryChannel">
            <path value="Slot.extension" />
            <sliceName value="deliveryChannel" />
            <short value="This describes the delivery channel of a scheduled appointment." />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="Slot.specialty">
            <path value="Slot.specialty" />
            <short value="The specialty of a practitioner that would be required to perform the service requested in this appointment." />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" />
            </binding>
        </element>
        <element id="Slot.appointmentType">
            <path value="Slot.appointmentType" />
            <short value="The style of appointment or patient that may be booked in the slot." />
            <mustSupport value="true" />
        </element>
        <element id="Slot.schedule">
            <path value="Slot.schedule" />
            <short value="A reference to the Schedule that this Slot is an interval of." />
            <mustSupport value="true" />
        </element>
        <element id="Slot.status">
            <path value="Slot.status" />
            <short value="The status of the slot, e.g free, busy, etc." />
            <mustSupport value="true" />
        </element>
        <element id="Slot.start">
            <path value="Slot.start" />
            <short value="Date/Time that the slot is to begin." />
            <mustSupport value="true" />
        </element>
        <element id="Slot.end">
            <path value="Slot.end" />
            <short value="Date/Time that the slot is to conclude." />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Slot",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot",
    "version": "1.3.0",
    "name": "UKCoreSlot",
    "title": "UK Core Slot",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Slot](https://hl7.org/fhir/R4/Slot.html).",
    "purpose": "Slot resources are used to provide time-slots that can be booked using an appointment. They do not provide any information about appointments that are available, just the time, and optionally what the time can be used for. These are effectively spaces of free/busy time.\nSlots can also be marked as busy without having appointments associated.",
    "copyright": "Copyright © 2021+ HL7 UK 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": "resource",
    "abstract": false,
    "type": "Slot",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Slot",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Slot.extension:deliveryChannel",
                "path": "Slot.extension",
                "sliceName": "deliveryChannel",
                "short": "This describes the delivery channel of a scheduled appointment.",
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Slot.specialty",
                "path": "Slot.specialty",
                "short": "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode"
                }
            },
            {
                "id": "Slot.appointmentType",
                "path": "Slot.appointmentType",
                "short": "The style of appointment or patient that may be booked in the slot.",
                "mustSupport": true
            },
            {
                "id": "Slot.schedule",
                "path": "Slot.schedule",
                "short": "A reference to the Schedule that this Slot is an interval of.",
                "mustSupport": true
            },
            {
                "id": "Slot.status",
                "path": "Slot.status",
                "short": "The status of the slot, e.g free, busy, etc.",
                "mustSupport": true
            },
            {
                "id": "Slot.start",
                "path": "Slot.start",
                "short": "Date/Time that the slot is to begin.",
                "mustSupport": true
            },
            {
                "id": "Slot.end",
                "path": "Slot.end",
                "short": "Date/Time that the slot is to conclude.",
                "mustSupport": true
            }
        ]
    }
}

Examples

An example to illustrate a free / available slot for a walk in vaccination

Example UKCore-Slot-AvailableWalkInVisit

Propose a change to UK Core Slot

StructureDefinition England-Practitioner

EnglandPractitioner (Practitioner)	I		UKCorePractitioner	There are no (further) constraints on this element Element id Practitioner Short description A person with a formal responsibility in the provisioning of healthcare or related services Definition A person who is directly or indirectly involved in the provisioning of healthcare. Data type UKCorePractitioner Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: Provider
id	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Practitioner.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Practitioner.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Practitioner.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Practitioner.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	S Σ	1..*	Identifier	Element id Practitioner.identifier Short description An identifier that applies to this person in this role. Definition An identifier that applies to this person in this role. Requirements Often, specific identities are assigned for the agent. Data type Identifier Sliced: Unordered, Closed, by system(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers
(All Slices)				There are no (further) constraints on this element
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.identifier.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 Practitioner.identifier.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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Practitioner.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uri	There are no (further) constraints on this element Element id Practitioner.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Practitioner.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Practitioner.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Practitioner.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
gmp-number	S Σ	0..1	EnglandIdentifierGeneralMedicalPractitionerCode	Element id Practitioner.identifier:gmp-number Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requirements Often, specific identities are assigned for the agent. Data type EnglandIdentifierGeneralMedicalPractitionerCode Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.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 Practitioner.identifier:gmp-number.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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.type.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 Practitioner.identifier:gmp-number.type.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
coding	Σ	1..1	Coding	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.type.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 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 Practitioner.identifier:gmp-number.type.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 Practitioner.identifier:gmp-number.type.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
system	Σ	0..1	uriFixed Value	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.type.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())` Fixed value http://terminology.hl7.org/CodeSystem/v2-0203 Mappings 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 Practitioner.identifier:gmp-number.type.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 v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	0..1	codeFixed Value	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.type.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. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value MD Mappings 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 Practitioner.identifier:gmp-number.type.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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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 Practitioner.identifier:gmp-number.type.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 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 Practitioner.identifier:gmp-number.type.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 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
system	Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.hl7.org.uk/Id/gmp-number Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Practitioner.identifier:gmp-number.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
gmc-number	S Σ	0..1	EnglandIdentifierGeneralMedicalCouncilReferenceNumber	Element id Practitioner.identifier:gmc-number Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requirements Often, specific identities are assigned for the agent. Data type EnglandIdentifierGeneralMedicalCouncilReferenceNumber Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.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 Practitioner.identifier:gmc-number.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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.type.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 Practitioner.identifier:gmc-number.type.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
coding	Σ	1..1	Coding	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.type.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 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 Practitioner.identifier:gmc-number.type.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 Practitioner.identifier:gmc-number.type.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
system	Σ	0..1	uriFixed Value	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.type.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())` Fixed value http://terminology.hl7.org/CodeSystem/v2-0203 Mappings 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 Practitioner.identifier:gmc-number.type.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 v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	0..1	codeFixed Value	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.type.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. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value MD Mappings 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 Practitioner.identifier:gmc-number.type.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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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 Practitioner.identifier:gmc-number.type.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 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 Practitioner.identifier:gmc-number.type.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 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
system	Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.hl7.org.uk/Id/gmc-number Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Practitioner.identifier:gmc-number.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
sds-user-id	S Σ	0..1	EnglandIdentifierSDSUserId	Element id Practitioner.identifier:sds-user-id Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requirements Often, specific identities are assigned for the agent. Data type EnglandIdentifierSDSUserId Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.identifier:sds-user-id.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 Practitioner.identifier:sds-user-id.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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.identifier:sds-user-id.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Practitioner.identifier:sds-user-id.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element id Practitioner.identifier:sds-user-id.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value https://fhir.nhs.uk/Id/sds-user-id Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id Practitioner.identifier:sds-user-id.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Practitioner.identifier:sds-user-id.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Practitioner.identifier:sds-user-id.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
active	Σ	0..1	boolean	There are no (further) constraints on this element Element id Practitioner.active Short description Whether this practitioner's record is in active use Definition Whether this practitioner's record is in active use. Requirements Need to be able to mark a practitioner record as not to be used because it was created in error. Comments If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status rim: ./statusCode
name	S Σ	0..*	HumanName	There are no (further) constraints on this element Element id Practitioner.name Short description The name(s) associated with the practitioner. Definition The name(s) associated with the practitioner. Requirements The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. Comments The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XCN Components rim: ./name servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
telecom	S Σ	0..*	ContactPoint	There are no (further) constraints on this element Element id Practitioner.telecom Short description A contact detail for the practitioner (that apply to all roles). Definition A contact detail for the practitioner, e.g. a telephone number or an email address. Requirements Need to know how to reach a practitioner independent to any roles the practitioner may have. Comments Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PRT-15, STF-10, ROL-12 rim: ./telecom servd: ./ContactPoints
address	Σ	0..*	Address	There are no (further) constraints on this element Element id Practitioner.address Short description Address(es) of the practitioner that are not role specific (typically home address) Definition Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. Requirements The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. Comments The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). Data type Address Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: ORC-24, STF-11, ROL-11, PRT-14 rim: ./addr servd: ./Addresses
gender	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id Practitioner.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Data type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: STF-5 rim: ./administrativeGender servd: ./GenderCode
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element id Practitioner.birthDate Short description The date on which the practitioner was born Definition The date of birth for the practitioner. Requirements Needed for identification. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: STF-6 rim: ./birthTime servd: (not represented in ServD)
photo		0..*	Attachment	There are no (further) constraints on this element Element id Practitioner.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. Data type Attachment Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: ./subjectOf/ObservationEvent[code="photo"]/value servd: ./ImageURI (only supports the URI reference)
qualification		0..*	BackboneElement	There are no (further) constraints on this element Element id Practitioner.qualification Short description Certification, licenses, or training pertaining to the provision of care Definition The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CER? rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications
id		0..1	string	There are no (further) constraints on this element Element id Practitioner.qualification.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 Practitioner.qualification.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Practitioner.qualification.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier		0..*	Identifier	There are no (further) constraints on this element Element id Practitioner.qualification.identifier Short description An identifier for this qualification for the practitioner Definition An identifier that applies to this person's qualification in this role. Requirements Often, specific identities are assigned for the qualification. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].id
code		1..1	CodeableConcept	There are no (further) constraints on this element Element id Practitioner.qualification.code Short description Coded representation of the qualification Definition Coded representation of the qualification. Data type CodeableConcept Binding Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications.Value
period		0..1	Period	There are no (further) constraints on this element Element id Practitioner.qualification.period Short description Period during which the qualification is valid Definition Period during which the qualification is valid. Requirements Qualifications are often for a limited period of time, and can be revoked. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime servd: ./Qualifications.StartDate and ./Qualifications.EndDate
issuer		0..1	Reference(Organization)	There are no (further) constraints on this element Element id Practitioner.qualification.issuer Short description Organization that regulates and issues the qualification Definition Organization that regulates and issues the qualification. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .playingEntity.playingRole[classCode=QUAL].scoper
communication		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Practitioner.communication Short description A language the practitioner can use in patient communication Definition A language the practitioner can use in patient communication. Requirements Knowing which language a practitioner speaks can help in facilitating communication with patients. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data type CodeableConcept Binding A ValueSet that identifies the language used by a person. AllLanguages (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PID-15, NK1-20, LAN-2 rim: ./languageCommunication servd: ./Languages.LanguageSpokenCode

Practitioner
Definition	A person who is directly or indirectly involved in the provisioning of healthcare.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: Provider
Practitioner.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Practitioner.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Practitioner.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
Practitioner.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
Practitioner.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
Practitioner.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Practitioner.identifier
Definition	An identifier that applies to this person in this role.
Cardinality	1...*
Type	Identifier
Must Support	True
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Slicing	Unordered, Closed, by system(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers
Practitioner.identifier.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
Mappings	rim: n/a
Practitioner.identifier.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Practitioner.identifier.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: N/A rim: Role.code or implied by context
Practitioner.identifier.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.5 rim: Role.code or implied by context
Practitioner.identifier.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General http://www.acme.com/identifiers/patient
Mappings	v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Practitioner.identifier.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
Practitioner.identifier.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
Practitioner.identifier.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
Practitioner.identifier:gmp-number
Definition	An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality	0...1
Type	EnglandIdentifierGeneralMedicalPractitionerCode
Must Support	True
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
Practitioner.identifier:gmp-number.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
Mappings	rim: n/a
Practitioner.identifier:gmp-number.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Practitioner.identifier:gmp-number.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: N/A rim: Role.code or implied by context
Practitioner.identifier:gmp-number.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.5 rim: Role.code or implied by context
Practitioner.identifier:gmp-number.type.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
Mappings	rim: n/a
Practitioner.identifier:gmp-number.type.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Practitioner.identifier:gmp-number.type.coding
Definition	A reference to a code defined by a terminology system.
Cardinality	1...1
Type	Coding
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Practitioner.identifier:gmp-number.type.coding.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
Mappings	rim: n/a
Practitioner.identifier:gmp-number.type.coding.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Practitioner.identifier:gmp-number.type.coding.system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	0...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 reference to some definition that establishes the system clearly and unambiguously.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	http://terminology.hl7.org/CodeSystem/v2-0203
Mappings	v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Practitioner.identifier:gmp-number.type.coding.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...1
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() or (children().count() > id.count())`
Mappings	v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Practitioner.identifier:gmp-number.type.coding.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	0...1
Type	code
Summary	True
Requirements	Need to refer to a particular code in the system.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	MD
Mappings	v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Practitioner.identifier:gmp-number.type.coding.display
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0...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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Practitioner.identifier:gmp-number.type.coding.userSelected
Definition	Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality	0...1
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() or (children().count() > id.count())`
Mappings	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 ]
Practitioner.identifier:gmp-number.type.text
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.
Cardinality	0...1
Type	string
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	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
Practitioner.identifier:gmp-number.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	https://fhir.hl7.org.uk/Id/gmp-number
Mappings	v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Practitioner.identifier:gmp-number.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
Practitioner.identifier:gmp-number.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
Practitioner.identifier:gmp-number.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
Practitioner.identifier:gmc-number
Definition	An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality	0...1
Type	EnglandIdentifierGeneralMedicalCouncilReferenceNumber
Must Support	True
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
Practitioner.identifier:gmc-number.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
Mappings	rim: n/a
Practitioner.identifier:gmc-number.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Practitioner.identifier:gmc-number.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: N/A rim: Role.code or implied by context
Practitioner.identifier:gmc-number.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.5 rim: Role.code or implied by context
Practitioner.identifier:gmc-number.type.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
Mappings	rim: n/a
Practitioner.identifier:gmc-number.type.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Practitioner.identifier:gmc-number.type.coding
Definition	A reference to a code defined by a terminology system.
Cardinality	1...1
Type	Coding
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Practitioner.identifier:gmc-number.type.coding.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
Mappings	rim: n/a
Practitioner.identifier:gmc-number.type.coding.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Practitioner.identifier:gmc-number.type.coding.system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	0...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 reference to some definition that establishes the system clearly and unambiguously.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	http://terminology.hl7.org/CodeSystem/v2-0203
Mappings	v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Practitioner.identifier:gmc-number.type.coding.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...1
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() or (children().count() > id.count())`
Mappings	v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Practitioner.identifier:gmc-number.type.coding.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	0...1
Type	code
Summary	True
Requirements	Need to refer to a particular code in the system.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	MD
Mappings	v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Practitioner.identifier:gmc-number.type.coding.display
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0...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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Practitioner.identifier:gmc-number.type.coding.userSelected
Definition	Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality	0...1
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() or (children().count() > id.count())`
Mappings	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 ]
Practitioner.identifier:gmc-number.type.text
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.
Cardinality	0...1
Type	string
Summary	True
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.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	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
Practitioner.identifier:gmc-number.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	https://fhir.hl7.org.uk/Id/gmc-number
Mappings	v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Practitioner.identifier:gmc-number.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
Practitioner.identifier:gmc-number.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
Practitioner.identifier:gmc-number.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
Practitioner.identifier:sds-user-id
Definition	An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality	0...1
Type	EnglandIdentifierSDSUserId
Must Support	True
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
Practitioner.identifier:sds-user-id.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
Mappings	rim: n/a
Practitioner.identifier:sds-user-id.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Practitioner.identifier:sds-user-id.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: N/A rim: Role.code or implied by context
Practitioner.identifier:sds-user-id.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.5 rim: Role.code or implied by context
Practitioner.identifier:sds-user-id.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	https://fhir.nhs.uk/Id/sds-user-id
Mappings	v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
Practitioner.identifier:sds-user-id.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
Practitioner.identifier:sds-user-id.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
Practitioner.identifier:sds-user-id.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
Practitioner.active
Definition	Whether this practitioner's record is in active use.
Cardinality	0...1
Type	boolean
Summary	True
Requirements	Need to be able to mark a practitioner record as not to be used because it was created in error.
Comments	If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status rim: ./statusCode
Practitioner.name
Definition	The name(s) associated with the practitioner.
Cardinality	0...*
Type	HumanName
Must Support	True
Summary	True
Requirements	The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.
Comments	The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: There is more than 1 name Use = usual Period is current to the date of the usage Use = official Other order as decided by internal business rules.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: XCN Components rim: ./name servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
Practitioner.telecom
Definition	A contact detail for the practitioner, e.g. a telephone number or an email address.
Cardinality	0...*
Type	ContactPoint
Must Support	True
Summary	True
Requirements	Need to know how to reach a practitioner independent to any roles the practitioner may have.
Comments	Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PRT-15, STF-10, ROL-12 rim: ./telecom servd: ./ContactPoints
Practitioner.address
Definition	Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
Cardinality	0...*
Type	Address
Summary	True
Requirements	The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.
Comments	The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: ORC-24, STF-11, ROL-11, PRT-14 rim: ./addr servd: ./Addresses
Practitioner.gender
Definition	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Cardinality	0...1
Type	code
Binding	The gender of a person used for administrative purposes. AdministrativeGender (required)
Summary	True
Requirements	Needed to address the person correctly.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: STF-5 rim: ./administrativeGender servd: ./GenderCode
Practitioner.birthDate
Definition	The date of birth for the practitioner.
Cardinality	0...1
Type	date
Summary	True
Requirements	Needed for identification.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: STF-6 rim: ./birthTime servd: (not represented in ServD)
Practitioner.photo
Definition	Image of the person.
Cardinality	0...*
Type	Attachment
Requirements	Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: ./subjectOf/ObservationEvent[code="photo"]/value servd: ./ImageURI (only supports the URI reference)
Practitioner.qualification
Definition	The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
Cardinality	0...*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CER? rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications
Practitioner.qualification.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
Mappings	rim: n/a
Practitioner.qualification.extension
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.
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.
Invariants	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
Practitioner.qualification.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
Practitioner.qualification.identifier
Definition	An identifier that applies to this person's qualification in this role.
Cardinality	0...*
Type	Identifier
Requirements	Often, specific identities are assigned for the qualification.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].id
Practitioner.qualification.code
Definition	Coded representation of the qualification.
Cardinality	1...1
Type	CodeableConcept
Binding	Specific qualification the practitioner has to provide a service. v2.0360.2.7 (example)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications.Value
Practitioner.qualification.period
Definition	Period during which the qualification is valid.
Cardinality	0...1
Type	Period
Requirements	Qualifications are often for a limited period of time, and can be revoked.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime servd: ./Qualifications.StartDate and ./Qualifications.EndDate
Practitioner.qualification.issuer
Definition	Organization that regulates and issues the qualification.
Cardinality	0...1
Type	Reference(Organization)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .playingEntity.playingRole[classCode=QUAL].scoper
Practitioner.communication
Definition	A language the practitioner can use in patient communication.
Cardinality	0...*
Type	CodeableConcept
Binding	A ValueSet that identifies the language used by a person. AllLanguages (required)
Requirements	Knowing which language a practitioner speaks can help in facilitating communication with patients.
Comments	The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PID-15, NK1-20, LAN-2 rim: ./languageCommunication servd: ./Languages.LanguageSpokenCode

Practitioner		..
Practitioner.identifier		1..
Practitioner.identifier.system		1..
Practitioner.identifier.value		1..
Practitioner.identifier	EnglandIdentifierGeneralMedicalPractitionerCode	0..1
Practitioner.identifier.system		..
Practitioner.identifier	EnglandIdentifierGeneralMedicalCouncilReferenceNumber	0..1
Practitioner.identifier.system		..
Practitioner.identifier	EnglandIdentifierSDSUserId	0..1
Practitioner.identifier.system		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="England-Practitioner" />
    <url value="https://fhir.nhs.uk/England/StructureDefinition/England-Practitioner" />
    <version value="0.0.1-current" />
    <name value="EnglandPractitioner" />
    <title value="England Practitioner" />
    <status value="draft" />
    <date value="2024-10-25T07:31:19+00:00" />
    <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="Based on requirments from the previous NHS Digital IG and NHS Data Dictionary" />
    <purpose value="Documentation of requirements for NHS England Healthcare Worker API" />
    <copyright value="Copyright &#169; 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \&amp;quot;License\&amp;quot;); 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 \&amp;quot;AS IS\&amp;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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Practitioner" />
    <baseDefinition value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
    <derivation value="constraint" />
    <differential>
        <element id="Practitioner.identifier">
            <path value="Practitioner.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <min value="1" />
        </element>
        <element id="Practitioner.identifier.system">
            <path value="Practitioner.identifier.system" />
            <min value="1" />
        </element>
        <element id="Practitioner.identifier.value">
            <path value="Practitioner.identifier.value" />
            <min value="1" />
        </element>
        <element id="Practitioner.identifier:gmp-number">
            <path value="Practitioner.identifier" />
            <sliceName value="gmp-number" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Practitioner-Code" />
            </type>
        </element>
        <element id="Practitioner.identifier:gmp-number.system">
            <path value="Practitioner.identifier.system" />
            <fixedUri value="https://fhir.hl7.org.uk/Id/gmp-number" />
        </element>
        <element id="Practitioner.identifier:gmc-number">
            <path value="Practitioner.identifier" />
            <sliceName value="gmc-number" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Council-Reference-Number" />
            </type>
        </element>
        <element id="Practitioner.identifier:gmc-number.system">
            <path value="Practitioner.identifier.system" />
            <fixedUri value="https://fhir.hl7.org.uk/Id/gmc-number" />
        </element>
        <element id="Practitioner.identifier:sds-user-id">
            <path value="Practitioner.identifier" />
            <sliceName value="sds-user-id" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-SDS-User-Id" />
            </type>
        </element>
        <element id="Practitioner.identifier:sds-user-id.system">
            <path value="Practitioner.identifier.system" />
            <fixedUri value="https://fhir.nhs.uk/Id/sds-user-id" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "England-Practitioner",
    "url": "https://fhir.nhs.uk/England/StructureDefinition/England-Practitioner",
    "version": "0.0.1-current",
    "name": "EnglandPractitioner",
    "title": "England Practitioner",
    "status": "draft",
    "date": "10/25/2024 07:31:19",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Based on requirments from the previous NHS Digital IG and NHS Data Dictionary",
    "purpose": "Documentation of requirements for NHS England Healthcare Worker API",
    "copyright": "Copyright © 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  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® 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": "resource",
    "abstract": false,
    "type": "Practitioner",
    "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Practitioner.identifier",
                "path": "Practitioner.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "closed"
                },
                "min": 1
            },
            {
                "id": "Practitioner.identifier.system",
                "path": "Practitioner.identifier.system",
                "min": 1
            },
            {
                "id": "Practitioner.identifier.value",
                "path": "Practitioner.identifier.value",
                "min": 1
            },
            {
                "id": "Practitioner.identifier:gmp-number",
                "path": "Practitioner.identifier",
                "sliceName": "gmp-number",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Practitioner-Code"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.identifier:gmp-number.system",
                "path": "Practitioner.identifier.system",
                "fixedUri": "https://fhir.hl7.org.uk/Id/gmp-number"
            },
            {
                "id": "Practitioner.identifier:gmc-number",
                "path": "Practitioner.identifier",
                "sliceName": "gmc-number",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Council-Reference-Number"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.identifier:gmc-number.system",
                "path": "Practitioner.identifier.system",
                "fixedUri": "https://fhir.hl7.org.uk/Id/gmc-number"
            },
            {
                "id": "Practitioner.identifier:sds-user-id",
                "path": "Practitioner.identifier",
                "sliceName": "sds-user-id",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-SDS-User-Id"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.identifier:sds-user-id.system",
                "path": "Practitioner.identifier.system",
                "fixedUri": "https://fhir.nhs.uk/Id/sds-user-id"
            }
        ]
    }
}

Examples

Practitioner example: Healthcare-Worker-Practitioner-Consultant-Example

Practitioner example: Healthcare-Worker-Practitioner-GP-Example

StructureDefinition England-PractitionerRole-Healthcare-Worker

EnglandPractitionerRoleHealthcareWorker (PractitionerRole)	I		UKCorePractitionerRole	There are no (further) constraints on this element Element id PractitionerRole Short description Roles/organizations the practitioner is associated with Definition A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. Data type UKCorePractitionerRole Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: ServiceSiteProvider
id	Σ	0..1	string	There are no (further) constraints on this element Element id PractitionerRole.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id PractitionerRole.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id PractitionerRole.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id PractitionerRole.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id PractitionerRole.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id PractitionerRole.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.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 resource. 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
identifier	S Σ	1..*	Identifier	Element id PractitionerRole.identifier Short description Business Identifiers that are specific to a role/location Definition Business Identifiers that are specific to a role/location. Requirements Often, specific identities are assigned for the agent. Data type Identifier Sliced: Unordered, Closed, by system(Pattern) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: .id servd: ./Identifiers
(All Slices)				There are no (further) constraints on this element
id		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.identifier.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 PractitionerRole.identifier.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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id PractitionerRole.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id PractitionerRole.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	Σ	1..1	uri	There are no (further) constraints on this element Element id PractitionerRole.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element id PractitionerRole.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id PractitionerRole.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id PractitionerRole.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
sds-user-profile-id	Σ	1..1	EnglandIdentifierSDSUserProfileId	Element id PractitionerRole.identifier:sds-user-profile-id Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requirements Often, specific identities are assigned for the agent. Data type EnglandIdentifierSDSUserProfileId Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: .id servd: ./Identifiers rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
active	S Σ	0..1	boolean	There are no (further) constraints on this element Element id PractitionerRole.active Short description Whether this practitioner role record is in active use. Definition Whether this practitioner role record is in active use. Requirements Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use. Comments If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status v2: STF-7 rim: .statusCode
period	S Σ	0..1	Period	There are no (further) constraints on this element Element id PractitionerRole.period Short description The period during which the practitioner is authorized to perform in these role(s). Definition The period during which the person is authorized to act as a practitioner in these role(s) for the organization. Requirements Even after the agencies is revoked, the fact that it existed must still be recorded. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.done[x] v2: PRD-8/9 / PRA-5.4 rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
id		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.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 PractitionerRole.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
start	S Σ I	0..1	dateTime	There are no (further) constraints on this element Element id PractitionerRole.period.start Short description Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive. Comments If the low element is missing, the meaning is that the low boundary is not known. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: DR.1 rim: ./low
end	S Σ I	0..1	dateTime	There are no (further) constraints on this element Element id PractitionerRole.period.end Short description End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Comments The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. Meaning when missing If the end of the period is missing, it means that the period is ongoing Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: DR.2 rim: ./high
practitioner	S Σ	0..1	Reference(Practitioner)	There are no (further) constraints on this element Element id PractitionerRole.practitioner Short description Practitioner that is able to provide the defined services for the organization. Definition Practitioner that is able to provide the defined services for the organization. Data type Reference(Practitioner) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .player
id		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.practitioner.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 PractitionerRole.practitioner.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
reference	Σ I	0..1	string	There are no (further) constraints on this element Element id PractitionerRole.practitioner.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() or (children().count() > id.count())` Mappings rim: N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id PractitionerRole.practitioner.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
identifier	Σ	0..1	EnglandIdentifierGeneralMedicalPractitionerCode, EnglandIdentifierGeneralMedicalCouncilReferenceNumber, EnglandIdentifierSDSUserId	Element id PractitionerRole.practitioner.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data type EnglandIdentifierGeneralMedicalPractitionerCode, EnglandIdentifierGeneralMedicalCouncilReferenceNumber, EnglandIdentifierSDSUserId Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .identifier
display	Σ	0..1	string	There are no (further) constraints on this element Element id PractitionerRole.practitioner.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() or (children().count() > id.count())` Mappings rim: N/A
organization	S Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id PractitionerRole.organization Short description Organization where the roles are available. Definition The organization where the Practitioner performs the roles associated. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .scoper
id		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.organization.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 PractitionerRole.organization.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
reference	Σ I	0..1	string	There are no (further) constraints on this element Element id PractitionerRole.organization.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() or (children().count() > id.count())` Mappings rim: N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id PractitionerRole.organization.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
identifier	Σ	1..1	EnglandIdentifierOrganisationCode	Element id PractitionerRole.organization.identifier Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data type EnglandIdentifierOrganisationCode Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .identifier rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
display	Σ	0..1	string	There are no (further) constraints on this element Element id PractitionerRole.organization.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() or (children().count() > id.count())` Mappings rim: N/A
code	Σ	0..*	CodeableConceptBinding	Element id PractitionerRole.code Short description Roles which this practitioner may perform Definition Roles which this practitioner is authorized to perform for the organization. Requirements Need to know what authority the practitioner has - what can they do? Comments A person may have more than one role. Data type CodeableConcept Binding The role a person plays representing an organization. EnglandJobRoleCode (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17 rim: .code servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
specialty	S Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id PractitionerRole.specialty Short description Specific specialty of the practitioner. Definition Specific specialty of the practitioner. Data type CodeableConcept Binding Specific specialty associated with the agency. UKCorePracticeSettingCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PRA-5 rim: .player.HealthCareProvider[@classCode = 'PROV'].code servd: ./Specialty
location	S Σ	0..*	Reference(Location)	There are no (further) constraints on this element Element id PractitionerRole.location Short description The location(s) at which this practitioner provides care. Definition The location(s) at which this practitioner provides care. Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.where[x] rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC'] servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)
healthcareService		0..*	Reference(HealthcareService)	There are no (further) constraints on this element Element id PractitionerRole.healthcareService Short description The list of healthcare services that this worker provides for this role's Organization/Location(s) Definition The list of healthcare services that this worker provides for this role's Organization/Location(s). Data type Reference(HealthcareService) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: EDU-2 / AFF-3 rim: .player.QualifiedEntity[@classCode = 'QUAL'].code
telecom	S Σ	0..*	ContactPoint	There are no (further) constraints on this element Element id PractitionerRole.telecom Short description Contact details that are specific to the role/location/service. Definition Contact details that are specific to the role/location/service. Requirements Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .telecom
availableTime		0..*	BackboneElement	There are no (further) constraints on this element Element id PractitionerRole.availableTime Short description Times the Service Site is available Definition A collection of times the practitioner is available or performing this role at the location and/or healthcareservice. Comments More detailed availability information may be provided in associated Schedule/Slot resources. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
id		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.availableTime.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 PractitionerRole.availableTime.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.availableTime.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
daysOfWeek		0..*	codeBinding	There are no (further) constraints on this element Element id PractitionerRole.availableTime.daysOfWeek Short description mon \| tue \| wed \| thu \| fri \| sat \| sun Definition Indicates which days of the week are available between the start and end Times. Data type code Binding The days of the week. DaysOfWeek (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
allDay		0..1	boolean	There are no (further) constraints on this element Element id PractitionerRole.availableTime.allDay Short description Always available? e.g. 24 hour service Definition Is this always available? (hence times are irrelevant) e.g. 24 hour service. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availableStartTime		0..1	time	There are no (further) constraints on this element Element id PractitionerRole.availableTime.availableStartTime Short description Opening time of day (ignored if allDay = true) Definition The opening time of day. Note: If the AllDay flag is set, then this time is ignored. Comments The timezone is expected to be for where this HealthcareService is provided at. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availableEndTime		0..1	time	There are no (further) constraints on this element Element id PractitionerRole.availableTime.availableEndTime Short description Closing time of day (ignored if allDay = true) Definition The closing time of day. Note: If the AllDay flag is set, then this time is ignored. Comments The timezone is expected to be for where this HealthcareService is provided at. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
notAvailable		0..*	BackboneElement	There are no (further) constraints on this element Element id PractitionerRole.notAvailable Short description Not available during this time due to provided reason Definition The practitioner is not available or performing this role during this period of time due to the provided reason. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
id		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.notAvailable.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 PractitionerRole.notAvailable.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 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.notAvailable.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
description		1..1	string	There are no (further) constraints on this element Element id PractitionerRole.notAvailable.description Short description Reason presented to the user explaining why time not available Definition The reason that can be presented to the user as to why this time is not available. 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
during		0..1	Period	There are no (further) constraints on this element Element id PractitionerRole.notAvailable.during Short description Service not available from this date Definition Service is not available (seasonally or for a public holiday) from this date. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availabilityExceptions		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.availabilityExceptions Short description Description of availability exceptions Definition A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
endpoint		0..*	Reference(Endpoint)	There are no (further) constraints on this element Element id PractitionerRole.endpoint Short description Technical endpoints providing access to services operated for the practitioner with this role Definition Technical endpoints providing access to services operated for the practitioner with this role. Requirements Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose. Data type Reference(Endpoint) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

PractitionerRole
Definition	A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Cardinality	0...*
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists()
Mappings	rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: ServiceSiteProvider
PractitionerRole.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	string
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
PractitionerRole.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
PractitionerRole.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
PractitionerRole.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. CommonLanguages (preferred)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
PractitionerRole.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: Act.text?
PractitionerRole.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Mappings	rim: N/A
PractitionerRole.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Invariants	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
PractitionerRole.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
PractitionerRole.identifier
Definition	Business Identifiers that are specific to a role/location.
Cardinality	1...*
Type	Identifier
Must Support	True
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Slicing	Unordered, Closed, by system(Pattern)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: .id servd: ./Identifiers
PractitionerRole.identifier.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
Mappings	rim: n/a
PractitionerRole.identifier.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
PractitionerRole.identifier.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . IdentifierUse (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: N/A rim: Role.code or implied by context
PractitionerRole.identifier.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.5 rim: Role.code or implied by context
PractitionerRole.identifier.system
Definition	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	Identifier.system is always case sensitive.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General http://www.acme.com/identifiers/patient
Mappings	v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
PractitionerRole.identifier.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Examples	General 123456
Mappings	v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
PractitionerRole.identifier.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
PractitionerRole.identifier.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
PractitionerRole.identifier:sds-user-profile-id
Definition	An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality	1...1
Type	EnglandIdentifierSDSUserProfileId
Summary	True
Requirements	Often, specific identities are assigned for the agent.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: .id servd: ./Identifiers rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
PractitionerRole.active
Definition	Whether this practitioner role record is in active use.
Cardinality	0...1
Type	boolean
Must Support	True
Summary	True
Requirements	Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.
Comments	If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.status v2: STF-7 rim: .statusCode
PractitionerRole.period
Definition	The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Cardinality	0...1
Type	Period
Must Support	True
Summary	True
Requirements	Even after the agencies is revoked, the fact that it existed must still be recorded.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.done[x] v2: PRD-8/9 / PRA-5.4 rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
PractitionerRole.period.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
Mappings	rim: n/a
PractitionerRole.period.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
PractitionerRole.period.start
Definition	The start of the period. The boundary is inclusive.
Cardinality	0...1
Type	dateTime
Must Support	True
Summary	True
Comments	If the low element is missing, the meaning is that the low boundary is not known.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: DR.1 rim: ./low
PractitionerRole.period.end
Definition	The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Cardinality	0...1
Type	dateTime
Must Support	True
Summary	True
Comments	The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: DR.2 rim: ./high
PractitionerRole.practitioner
Definition	Practitioner that is able to provide the defined services for the organization.
Cardinality	0...1
Type	Reference(Practitioner)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .player
PractitionerRole.practitioner.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
Mappings	rim: n/a
PractitionerRole.practitioner.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
PractitionerRole.practitioner.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	0...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() or (children().count() > id.count())`
Mappings	rim: N/A
PractitionerRole.practitioner.type
Definition	The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality	0...1
Type	uri
Binding	Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)
Summary	True
Comments	This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
PractitionerRole.practitioner.identifier
Definition	An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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...1
Type	EnglandIdentifierGeneralMedicalPractitionerCode, EnglandIdentifierGeneralMedicalCouncilReferenceNumber, EnglandIdentifierSDSUserId
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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .identifier
PractitionerRole.practitioner.display
Definition	Plain text narrative that identifies the resource in addition to the resource reference.
Cardinality	0...1
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() or (children().count() > id.count())`
Mappings	rim: N/A
PractitionerRole.organization
Definition	The organization where the Practitioner performs the roles associated.
Cardinality	0...1
Type	Reference(Organization)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .scoper
PractitionerRole.organization.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
Mappings	rim: n/a
PractitionerRole.organization.extension
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.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
PractitionerRole.organization.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	0...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() or (children().count() > id.count())`
Mappings	rim: N/A
PractitionerRole.organization.type
Definition	The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality	0...1
Type	uri
Binding	Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)
Summary	True
Comments	This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
PractitionerRole.organization.identifier
Definition	An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality	1...1
Type	EnglandIdentifierOrganisationCode
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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .identifier rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - 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
PractitionerRole.organization.display
Definition	Plain text narrative that identifies the resource in addition to the resource reference.
Cardinality	0...1
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() or (children().count() > id.count())`
Mappings	rim: N/A
PractitionerRole.code
Definition	Roles which this practitioner is authorized to perform for the organization.
Cardinality	0...*
Type	CodeableConcept
Binding	The role a person plays representing an organization. EnglandJobRoleCode (required)
Summary	True
Requirements	Need to know what authority the practitioner has - what can they do?
Comments	A person may have more than one role.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17 rim: .code servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
PractitionerRole.specialty
Definition	Specific specialty of the practitioner.
Cardinality	0...*
Type	CodeableConcept
Binding	Specific specialty associated with the agency. UKCorePracticeSettingCode (extensible)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: PRA-5 rim: .player.HealthCareProvider[@classCode = 'PROV'].code servd: ./Specialty
PractitionerRole.location
Definition	The location(s) at which this practitioner provides care.
Cardinality	0...*
Type	Reference(Location)
Must Support	True
Summary	True
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	w5: FiveWs.where[x] rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC'] servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)
PractitionerRole.healthcareService
Definition	The list of healthcare services that this worker provides for this role's Organization/Location(s).
Cardinality	0...*
Type	Reference(HealthcareService)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	v2: EDU-2 / AFF-3 rim: .player.QualifiedEntity[@classCode = 'QUAL'].code
PractitionerRole.telecom
Definition	Contact details that are specific to the role/location/service.
Cardinality	0...*
Type	ContactPoint
Must Support	True
Summary	True
Requirements	Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .telecom
PractitionerRole.availableTime
Definition	A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
Cardinality	0...*
Type	BackboneElement
Comments	More detailed availability information may be provided in associated Schedule/Slot resources.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
PractitionerRole.availableTime.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
Mappings	rim: n/a
PractitionerRole.availableTime.extension
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.
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.
Invariants	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
PractitionerRole.availableTime.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
PractitionerRole.availableTime.daysOfWeek
Definition	Indicates which days of the week are available between the start and end Times.
Cardinality	0...*
Type	code
Binding	The days of the week. DaysOfWeek (required)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
PractitionerRole.availableTime.allDay
Definition	Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Cardinality	0...1
Type	boolean
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
PractitionerRole.availableTime.availableStartTime
Definition	The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
Cardinality	0...1
Type	time
Comments	The timezone is expected to be for where this HealthcareService is provided at.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
PractitionerRole.availableTime.availableEndTime
Definition	The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Cardinality	0...1
Type	time
Comments	The timezone is expected to be for where this HealthcareService is provided at.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
PractitionerRole.notAvailable
Definition	The practitioner is not available or performing this role during this period of time due to the provided reason.
Cardinality	0...*
Type	BackboneElement
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
PractitionerRole.notAvailable.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
Mappings	rim: n/a
PractitionerRole.notAvailable.extension
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.
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.
Invariants	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
PractitionerRole.notAvailable.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: N/A
PractitionerRole.notAvailable.description
Definition	The reason that can be presented to the user as to why this time is not available.
Cardinality	1...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
PractitionerRole.notAvailable.during
Definition	Service is not available (seasonally or for a public holiday) from this date.
Cardinality	0...1
Type	Period
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
PractitionerRole.availabilityExceptions
Definition	A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
Cardinality	0...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: .effectiveTime
PractitionerRole.endpoint
Definition	Technical endpoints providing access to services operated for the practitioner with this role.
Cardinality	0...*
Type	Reference(Endpoint)
Requirements	Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a

PractitionerRole		..
PractitionerRole.identifier		1..
PractitionerRole.identifier.system		1..
PractitionerRole.identifier.value		1..
PractitionerRole.identifier	EnglandIdentifierSDSUserProfileId	1..1
PractitionerRole.period		..
PractitionerRole.period.start		..
PractitionerRole.period.end		..
PractitionerRole.practitioner		..
PractitionerRole.practitioner.identifier	EnglandIdentifierGeneralMedicalPractitionerCode, EnglandIdentifierGeneralMedicalCouncilReferenceNumber, EnglandIdentifierSDSUserId	0..
PractitionerRole.organization		..
PractitionerRole.organization.identifier	EnglandIdentifierOrganisationCode	1..
PractitionerRole.code		..

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="England-PractitionerRole-Healthcare-Worker" />
    <url value="https://fhir.nhs.uk/England/StructureDefinition/England-PractitionerRole-Healthcare-Worker" />
    <version value="0.0.1-current" />
    <name value="EnglandPractitionerRoleHealthcareWorker" />
    <title value="England Practitioner Role Healthcare Worker" />
    <status value="draft" />
    <date value="2024-10-25T07:31:19+00:00" />
    <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="Based on requirments from the previous NHS Digital IG and NHS Data Dictionary" />
    <purpose value="Documentation of requirements for NHS England Healthcare Worker API" />
    <copyright value="Copyright &#169; 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \&amp;quot;License\&amp;quot;); 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 \&amp;quot;AS IS\&amp;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  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="PractitionerRole" />
    <baseDefinition value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
    <derivation value="constraint" />
    <differential>
        <element id="PractitionerRole">
            <path value="PractitionerRole" />
        </element>
        <element id="PractitionerRole.identifier">
            <path value="PractitionerRole.identifier" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="system" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="PractitionerRole.identifier.system">
            <path value="PractitionerRole.identifier.system" />
            <min value="1" />
        </element>
        <element id="PractitionerRole.identifier.value">
            <path value="PractitionerRole.identifier.value" />
            <min value="1" />
        </element>
        <element id="PractitionerRole.identifier:sds-user-profile-id">
            <path value="PractitionerRole.identifier" />
            <sliceName value="sds-user-profile-id" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-SDS-User-Profile-Id" />
            </type>
        </element>
        <element id="PractitionerRole.period.start">
            <path value="PractitionerRole.period.start" />
            <mustSupport value="true" />
        </element>
        <element id="PractitionerRole.period.end">
            <path value="PractitionerRole.period.end" />
            <mustSupport value="true" />
        </element>
        <element id="PractitionerRole.practitioner.identifier">
            <path value="PractitionerRole.practitioner.identifier" />
            <min value="0" />
            <type>
                <code value="Identifier" />
                <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Practitioner-Code" />
                <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Council-Reference-Number" />
                <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-SDS-User-Id" />
            </type>
        </element>
        <element id="PractitionerRole.organization.identifier">
            <path value="PractitionerRole.organization.identifier" />
            <min value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Organisation-Code" />
            </type>
        </element>
        <element id="PractitionerRole.code">
            <path value="PractitionerRole.code" />
            <binding>
                <strength value="required" />
                <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-JobRoleCode" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "England-PractitionerRole-Healthcare-Worker",
    "url": "https://fhir.nhs.uk/England/StructureDefinition/England-PractitionerRole-Healthcare-Worker",
    "version": "0.0.1-current",
    "name": "EnglandPractitionerRoleHealthcareWorker",
    "title": "England Practitioner Role Healthcare Worker",
    "status": "draft",
    "date": "10/25/2024 07:31:19",
    "publisher": "NHS England",
    "contact":  [
        {
            "name": "NHS England",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Based on requirments from the previous NHS Digital IG and NHS Data Dictionary",
    "purpose": "Documentation of requirements for NHS England Healthcare Worker API",
    "copyright": "Copyright © 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  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® 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": "resource",
    "abstract": false,
    "type": "PractitionerRole",
    "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "PractitionerRole",
                "path": "PractitionerRole"
            },
            {
                "id": "PractitionerRole.identifier",
                "path": "PractitionerRole.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "system"
                        }
                    ],
                    "rules": "closed"
                },
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.identifier.system",
                "path": "PractitionerRole.identifier.system",
                "min": 1
            },
            {
                "id": "PractitionerRole.identifier.value",
                "path": "PractitionerRole.identifier.value",
                "min": 1
            },
            {
                "id": "PractitionerRole.identifier:sds-user-profile-id",
                "path": "PractitionerRole.identifier",
                "sliceName": "sds-user-profile-id",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-SDS-User-Profile-Id"
                        ]
                    }
                ]
            },
            {
                "id": "PractitionerRole.period.start",
                "path": "PractitionerRole.period.start",
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.period.end",
                "path": "PractitionerRole.period.end",
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.practitioner.identifier",
                "path": "PractitionerRole.practitioner.identifier",
                "min": 0,
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Practitioner-Code",
                            "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Council-Reference-Number",
                            "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-SDS-User-Id"
                        ]
                    }
                ]
            },
            {
                "id": "PractitionerRole.organization.identifier",
                "path": "PractitionerRole.organization.identifier",
                "min": 1,
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Organisation-Code"
                        ]
                    }
                ]
            },
            {
                "id": "PractitionerRole.code",
                "path": "PractitionerRole.code",
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-JobRoleCode"
                }
            }
        ]
    }
}