Profiles
StructureDefinition UKCore-HealthCareService
| HealthcareService | |||
| Short | The details of a healthcare service available at a location | ||
| Definition | The details of a healthcare service available at a location. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.id | |||
| Short | 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. | ||
| 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 | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.implicitRules | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.contained | |||
| Short | Contained, inline 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. | ||
| 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 |
| ||
| HealthcareService.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.identifier | |||
| Short | External identifiers for this item | ||
| Definition | External identifiers for this item. | ||
| Cardinality | 0..* | ||
| Type | Identifier | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.active | |||
| Short | 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. | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.providedBy | |||
| Short | The organization that provides this healthcare service. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.category | |||
| Short | Broad category of service being performed or delivered | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.type | |||
| Short | The type of service provided by this healthcare service. | ||
| 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). | ||
| Must Support | True | ||
| Summary | True | ||
| Alias | service type | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.specialty | |||
| Short | Specialties handled by the HealthcareService | ||
| 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. | ||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.location | |||
| Short | Location(s) where service may be provided | ||
| Definition | The location(s) where this healthcare service may be provided. | ||
| Cardinality | 0..* | ||
| Type | Reference(Location) | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.name | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.comment | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.extraDetails | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | markdown | ||
| Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.photo | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Attachment | ||
| Summary | True | ||
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.telecom | |||
| Short | Contacts related to the healthcare service | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.coverageArea | |||
| Short | Location(s) service is intended for/available to | ||
| 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". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.serviceProvisionCode | |||
| Short | Conditions under which service is available/offered | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.eligibility | |||
| Short | 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? | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.eligibility.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| HealthcareService.eligibility.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.eligibility.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.eligibility.code | |||
| Short | Coded value for the eligibility | ||
| Definition | Coded value for the eligibility. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | Coded values underwhich a specific service is made available. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.eligibility.comment | |||
| Short | Describes the eligibility conditions for the service | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.program | |||
| Short | Programs that this service is applicable to | ||
| Definition | Programs that this service is applicable to. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Government or local programs that this service applies to. | ||
| Comments | Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.characteristic | |||
| Short | Collection of characteristics (attributes) | ||
| Definition | Collection of characteristics (attributes). | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||
| Comments | These could be such things as is wheelchair accessible. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.communication | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | A ValueSet that identifies the language used by a person.
| ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.referralMethod | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | The methods of referral can be used when referring to a specific HealthCareService resource. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.appointmentRequired | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.availableTime | |||
| Short | Times the Service Site is available | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.availableTime.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| HealthcareService.availableTime.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.availableTime.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.availableTime.daysOfWeek | |||
| Short | mon | tue | wed | thu | fri | sat | sun | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.availableTime.allDay | |||
| Short | Always available? e.g. 24 hour service | ||
| Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.availableTime.availableStartTime | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | time | ||
| Comments | The time zone is expected to be for where this HealthcareService is provided at. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.availableTime.availableEndTime | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | time | ||
| Comments | The time zone is expected to be for where this HealthcareService is provided at. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.notAvailable | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.notAvailable.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| HealthcareService.notAvailable.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.notAvailable.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.notAvailable.description | |||
| Short | 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. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.notAvailable.during | |||
| Short | Service not available from this date | ||
| Definition | Service is not available (seasonally or for a public holiday) from this date. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.availabilityExceptions | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService.endpoint | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | Reference(Endpoint) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| HealthcareService | 0..* | |
| HealthcareService.id | string | 0..1 |
| HealthcareService.meta | Meta | 0..1 |
| HealthcareService.implicitRules | uri | 0..1 |
| HealthcareService.language | code | 0..1 |
| HealthcareService.text | Narrative | 0..1 |
| HealthcareService.contained | Resource | 0..* |
| HealthcareService.extension | Extension | 0..* |
| HealthcareService.modifierExtension | Extension | 0..* |
| HealthcareService.identifier | Identifier | 0..* |
| HealthcareService.active | boolean | 0..1 |
| HealthcareService.providedBy | Reference(Organization) | 0..1 |
| HealthcareService.category | CodeableConcept | 0..* |
| HealthcareService.type | CodeableConcept | 0..* |
| HealthcareService.specialty | CodeableConcept | 0..* |
| HealthcareService.location | Reference(Location) | 0..* |
| HealthcareService.name | string | 0..1 |
| HealthcareService.comment | string | 0..1 |
| HealthcareService.extraDetails | markdown | 0..1 |
| HealthcareService.photo | Attachment | 0..1 |
| HealthcareService.telecom | ContactPoint | 0..* |
| HealthcareService.coverageArea | Reference(Location) | 0..* |
| HealthcareService.serviceProvisionCode | CodeableConcept | 0..* |
| HealthcareService.eligibility | BackboneElement | 0..* |
| HealthcareService.eligibility.id | string | 0..1 |
| HealthcareService.eligibility.extension | Extension | 0..* |
| HealthcareService.eligibility.modifierExtension | Extension | 0..* |
| HealthcareService.eligibility.code | CodeableConcept | 0..1 |
| HealthcareService.eligibility.comment | markdown | 0..1 |
| HealthcareService.program | CodeableConcept | 0..* |
| HealthcareService.characteristic | CodeableConcept | 0..* |
| HealthcareService.communication | CodeableConcept | 0..* |
| HealthcareService.referralMethod | CodeableConcept | 0..* |
| HealthcareService.appointmentRequired | boolean | 0..1 |
| HealthcareService.availableTime | BackboneElement | 0..* |
| HealthcareService.availableTime.id | string | 0..1 |
| HealthcareService.availableTime.extension | Extension | 0..* |
| HealthcareService.availableTime.modifierExtension | Extension | 0..* |
| HealthcareService.availableTime.daysOfWeek | code | 0..* |
| HealthcareService.availableTime.allDay | boolean | 0..1 |
| HealthcareService.availableTime.availableStartTime | time | 0..1 |
| HealthcareService.availableTime.availableEndTime | time | 0..1 |
| HealthcareService.notAvailable | BackboneElement | 0..* |
| HealthcareService.notAvailable.id | string | 0..1 |
| HealthcareService.notAvailable.extension | Extension | 0..* |
| HealthcareService.notAvailable.modifierExtension | Extension | 0..* |
| HealthcareService.notAvailable.description | string | 1..1 |
| HealthcareService.notAvailable.during | Period | 0..1 |
| HealthcareService.availabilityExceptions | string | 0..1 |
| HealthcareService.endpoint | Reference(Endpoint) | 0..* |
Examples
An example to illustrate information about an orthopaedic service within a HealthcareService resourceExample UKCore-HealthcareService-OrthopaedicService
StructureDefinition UKCore-Location
| Location | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.id | |||
| Short | 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. | ||
| 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 | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.implicitRules | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.contained | |||
| Short | Contained, inline 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. | ||
| 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 |
| ||
| Location.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.identifier | |||
| Short | Unique code or number identifying the location to its users | ||
| 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.identifier:odsSiteCode | |||
| Short | ODS Site code to identify the organisation at site level | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.identifier:odsSiteCode.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Location.identifier:odsSiteCode.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.identifier:odsSiteCode.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.identifier:odsSiteCode.type | |||
| Short | Description of identifier | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.identifier:odsSiteCode.system | |||
| Short | ODS Code | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.nhs.uk/Id/ods-site-code | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Location.identifier:odsSiteCode.value | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Location.identifier:odsSiteCode.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.identifier:odsSiteCode.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.status | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Indicates whether the location is still in use. | ||
| Must Support | True | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.operationalStatus | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Coding | ||
| Binding | The operational status if the location (where typically a bed/room). | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.name | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.alias | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.description | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Humans need additional information to verify a correct location has been identified. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.mode | |||
| Short | instance | kind | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.type | |||
| Short | Type of function performed | ||
| Definition | Indicates the type of function performed at the location. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Indicates the type of function performed at the location. | ||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.telecom | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | ContactPoint | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.address | |||
| Short | If locations can be visited, we need to keep track of their 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.physicalType | |||
| Short | Physical form of the location | ||
| Definition | Physical form of the location, e.g. building, room, vehicle, road. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | Physical form of the location. | ||
| Summary | True | ||
| Requirements | For purposes of showing relevant locations in queries, we need to categorize locations. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.position | |||
| Short | 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). | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Requirements | For mobile applications and automated route-finding knowing the exact location of the Location is required. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.position.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Location.position.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.position.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.position.longitude | |||
| Short | 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). | ||
| Cardinality | 1..1 | ||
| Type | decimal | ||
| Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.position.latitude | |||
| Short | 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). | ||
| Cardinality | 1..1 | ||
| Type | decimal | ||
| Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.position.altitude | |||
| Short | 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). | ||
| Cardinality | 0..1 | ||
| Type | decimal | ||
| Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.managingOrganization | |||
| Short | Organization responsible for provisioning and upkeep | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.partOf | |||
| Short | Another Location this one is physically a part of | ||
| 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. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.hoursOfOperation | |||
| Short | What days/times during a week is this location usually open | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.hoursOfOperation.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Location.hoursOfOperation.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.hoursOfOperation.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.hoursOfOperation.daysOfWeek | |||
| Short | mon | tue | wed | thu | fri | sat | sun | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.hoursOfOperation.allDay | |||
| Short | The Location is open all day | ||
| Definition | The Location is open all day. | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.hoursOfOperation.openingTime | |||
| Short | Time that the Location opens | ||
| Definition | Time that the Location opens. | ||
| Cardinality | 0..1 | ||
| Type | time | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.hoursOfOperation.closingTime | |||
| Short | Time that the Location closes | ||
| Definition | Time that the Location closes. | ||
| Cardinality | 0..1 | ||
| Type | time | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.availabilityExceptions | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location.endpoint | |||
| Short | Technical endpoints providing access to services operated for the location | ||
| 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. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Location | 0..* | |
| Location.id | string | 0..1 |
| Location.meta | Meta | 0..1 |
| Location.implicitRules | uri | 0..1 |
| Location.language | code | 0..1 |
| Location.text | Narrative | 0..1 |
| Location.contained | Resource | 0..* |
| Location.extension | Extension | 0..* |
| Location.modifierExtension | Extension | 0..* |
| Location.identifier | Identifier | 0..* |
| Location.identifier:odsSiteCode | Identifier | 0..1 |
| Location.identifier:odsSiteCode.id | string | 0..1 |
| Location.identifier:odsSiteCode.extension | Extension | 0..* |
| Location.identifier:odsSiteCode.use | code | 0..1 |
| Location.identifier:odsSiteCode.type | CodeableConcept | 0..1 |
| Location.identifier:odsSiteCode.system | uri | 1..1 |
| Location.identifier:odsSiteCode.value | string | 1..1 |
| Location.identifier:odsSiteCode.period | Period | 0..1 |
| Location.identifier:odsSiteCode.assigner | Reference(Organization) | 0..1 |
| Location.status | code | 0..1 |
| Location.operationalStatus | Coding | 0..1 |
| Location.name | string | 0..1 |
| Location.alias | string | 0..* |
| Location.description | string | 0..1 |
| Location.mode | code | 0..1 |
| Location.type | CodeableConcept | 0..* |
| Location.telecom | ContactPoint | 0..* |
| Location.address | Address | 0..1 |
| Location.physicalType | CodeableConcept | 0..1 |
| Location.position | BackboneElement | 0..1 |
| Location.position.id | string | 0..1 |
| Location.position.extension | Extension | 0..* |
| Location.position.modifierExtension | Extension | 0..* |
| Location.position.longitude | decimal | 1..1 |
| Location.position.latitude | decimal | 1..1 |
| Location.position.altitude | decimal | 0..1 |
| Location.managingOrganization | Reference(Organization) | 0..1 |
| Location.partOf | Reference(Location) | 0..1 |
| Location.hoursOfOperation | BackboneElement | 0..* |
| Location.hoursOfOperation.id | string | 0..1 |
| Location.hoursOfOperation.extension | Extension | 0..* |
| Location.hoursOfOperation.modifierExtension | Extension | 0..* |
| Location.hoursOfOperation.daysOfWeek | code | 0..* |
| Location.hoursOfOperation.allDay | boolean | 0..1 |
| Location.hoursOfOperation.openingTime | time | 0..1 |
| Location.hoursOfOperation.closingTime | time | 0..1 |
| Location.availabilityExceptions | string | 0..1 |
| Location.endpoint | Reference(Endpoint) | 0..* |
Examples
1. An example to illustrate a clinical unit within a hospitalExample UKCore-Location-CardiologySJUH
2. An example to illustrate a GP clinic location
Example UKCore-Location-GeneralPracticeNurseClinic
StructureDefinition UKCore-Organization
| Organization | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.id | |||
| Short | 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. | ||
| 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 | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.implicitRules | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.contained | |||
| Short | Contained, inline 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. | ||
| 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 |
| ||
| Organization.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.extension:mainLocation | |||
| Short | The main location of the organisation. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.extension:organizationPeriod | |||
| Short | The date range that this organization SHOULD be considered available. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.extension:organizationPeriod.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Organization.extension:organizationPeriod.extension | |||
| Short | Additional content defined by implementations | ||
| 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..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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.extension:organizationPeriod.url | |||
| Short | identifies the meaning of the extension | ||
| 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 |
| ||
| Organization.extension:organizationPeriod.value[x] | |||
| Short | The date range that this organization SHOULD be considered available. | ||
| Definition | The date range that this organization SHOULD be considered available. | ||
| Cardinality | 1..1 | ||
| Type | Period | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier | |||
| Short | Identifies this organization across multiple systems. | ||
| 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, org-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsOrganisationCode | |||
| Short | Organisation Data Service code | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, org-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsOrganisationCode.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Organization.identifier:odsOrganisationCode.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsOrganisationCode.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsOrganisationCode.type | |||
| Short | Description of identifier | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsOrganisationCode.system | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.nhs.uk/Id/ods-organization-code | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Organization.identifier:odsOrganisationCode.value | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Organization.identifier:odsOrganisationCode.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsOrganisationCode.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsSiteCode | |||
| Short | ODS Site code to identify the organisation at site level | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, org-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsSiteCode.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Organization.identifier:odsSiteCode.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsSiteCode.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsSiteCode.type | |||
| Short | Description of identifier | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsSiteCode.system | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.nhs.uk/Id/ods-site-code | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Organization.identifier:odsSiteCode.value | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Organization.identifier:odsSiteCode.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.identifier:odsSiteCode.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.active | |||
| Short | Identifies this organization across multiple systems. | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.type | |||
| Short | Kind of organization | ||
| 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 | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.name | |||
| Short | A name associated with the organization. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, org-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.alias | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.telecom | |||
| Short | Contact details for the organization. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, org-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.address | |||
| Short | An address for the organization. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, org-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.partOf | |||
| Short | The organization of which this organization forms a part | ||
| 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. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.contact | |||
| Short | Contact for the organization for a certain purpose | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.contact.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Organization.contact.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.contact.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.contact.purpose | |||
| Short | The type of contact | ||
| 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. | ||
| Requirements | Need to distinguish between multiple contact persons. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.contact.name | |||
| Short | A name associated with the contact | ||
| Definition | A name associated with the contact. | ||
| Cardinality | 0..1 | ||
| Type | HumanName | ||
| Requirements | Need to be able to track the person by name. | ||
| Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.contact.telecom | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | ContactPoint | ||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.contact.address | |||
| Short | Visiting or postal addresses for the contact | ||
| 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. | ||
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization.endpoint | |||
| Short | Technical endpoints providing access to services operated for the organization | ||
| 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. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Organization | 0..* | |
| Organization.id | string | 0..1 |
| Organization.meta | Meta | 0..1 |
| Organization.implicitRules | uri | 0..1 |
| Organization.language | code | 0..1 |
| Organization.text | Narrative | 0..1 |
| Organization.contained | Resource | 0..* |
| Organization.extension | Extension | 0..* |
| Organization.extension:mainLocation | Extension | 0..1 |
| Organization.extension:organizationPeriod | Extension | 0..1 |
| Organization.extension:organizationPeriod.id | string | 0..1 |
| Organization.extension:organizationPeriod.extension | Extension | 0..0 |
| Organization.extension:organizationPeriod.url | uri | 1..1 |
| Organization.extension:organizationPeriod.value[x] | Period | 1..1 |
| Organization.modifierExtension | Extension | 0..* |
| Organization.identifier | Identifier | 0..* |
| Organization.identifier:odsOrganisationCode | Identifier | 0..1 |
| Organization.identifier:odsOrganisationCode.id | string | 0..1 |
| Organization.identifier:odsOrganisationCode.extension | Extension | 0..* |
| Organization.identifier:odsOrganisationCode.use | code | 0..1 |
| Organization.identifier:odsOrganisationCode.type | CodeableConcept | 0..1 |
| Organization.identifier:odsOrganisationCode.system | uri | 1..1 |
| Organization.identifier:odsOrganisationCode.value | string | 1..1 |
| Organization.identifier:odsOrganisationCode.period | Period | 0..1 |
| Organization.identifier:odsOrganisationCode.assigner | Reference(Organization) | 0..1 |
| Organization.identifier:odsSiteCode | Identifier | 0..1 |
| Organization.identifier:odsSiteCode.id | string | 0..1 |
| Organization.identifier:odsSiteCode.extension | Extension | 0..* |
| Organization.identifier:odsSiteCode.use | code | 0..1 |
| Organization.identifier:odsSiteCode.type | CodeableConcept | 0..1 |
| Organization.identifier:odsSiteCode.system | uri | 1..1 |
| Organization.identifier:odsSiteCode.value | string | 1..1 |
| Organization.identifier:odsSiteCode.period | Period | 0..1 |
| Organization.identifier:odsSiteCode.assigner | Reference(Organization) | 0..1 |
| Organization.active | boolean | 0..1 |
| Organization.type | CodeableConcept | 0..* |
| Organization.name | string | 0..1 |
| Organization.alias | string | 0..* |
| Organization.telecom | ContactPoint | 0..* |
| Organization.address | Address | 0..* |
| Organization.partOf | Reference(Organization) | 0..1 |
| Organization.contact | BackboneElement | 0..* |
| Organization.contact.id | string | 0..1 |
| Organization.contact.extension | Extension | 0..* |
| Organization.contact.modifierExtension | Extension | 0..* |
| Organization.contact.purpose | CodeableConcept | 0..1 |
| Organization.contact.name | HumanName | 0..1 |
| Organization.contact.telecom | ContactPoint | 0..* |
| Organization.contact.address | Address | 0..1 |
| Organization.endpoint | Reference(Endpoint) | 0..* |
Examples
1. An example to illustrate an organizationExample UKCore-Organization-WhiteRoseMedicalCentre
2. An example to illustrate an NHS Trust organisation
Example UKCore-Organization-LeedsTeachingHospital
StructureDefinition UKCore-OrganizationAffiliation
StructureDefinition UKCore-Practitioner
| Practitioner | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.id | |||
| Short | 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. | ||
| 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 | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.implicitRules | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.contained | |||
| Short | Contained, inline 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. | ||
| 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 |
| ||
| Practitioner.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier | |||
| Short | An identifier that applies to this person in this role. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.active | |||
| Short | Whether this practitioner's record is in active use | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name | |||
| Short | The name(s) associated with the practitioner. | ||
| 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:
| ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.telecom | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.address | |||
| Short | 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. | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.gender | |||
| Short | male | female | other | unknown | ||
| 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. | ||
| Summary | True | ||
| Requirements | Needed to address the person correctly. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.birthDate | |||
| Short | The date on which the practitioner was born | ||
| Definition | The date of birth for the practitioner. | ||
| Cardinality | 0..1 | ||
| Type | date | ||
| Summary | True | ||
| Requirements | Needed for identification. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.photo | |||
| Short | Image of the person | ||
| 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. | ||
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.qualification.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.identifier | |||
| Short | An identifier for this qualification for the practitioner | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.code | |||
| Short | Coded representation of the qualification | ||
| Definition | Coded representation of the qualification. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Specific qualification the practitioner has to provide a service. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.period | |||
| Short | Period during which the qualification is valid | ||
| 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. | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.issuer | |||
| Short | Organization that regulates and issues the qualification | ||
| Definition | Organization that regulates and issues the qualification. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.communication | |||
| Short | A language the practitioner can use in patient 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.
| ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner | 0..* | |
| Practitioner.id | string | 0..1 |
| Practitioner.meta | Meta | 0..1 |
| Practitioner.implicitRules | uri | 0..1 |
| Practitioner.language | code | 0..1 |
| Practitioner.text | Narrative | 0..1 |
| Practitioner.contained | Resource | 0..* |
| Practitioner.extension | Extension | 0..* |
| Practitioner.modifierExtension | Extension | 0..* |
| Practitioner.identifier | Identifier | 0..* |
| Practitioner.active | boolean | 0..1 |
| Practitioner.name | HumanName | 0..* |
| Practitioner.telecom | ContactPoint | 0..* |
| Practitioner.address | Address | 0..* |
| Practitioner.gender | code | 0..1 |
| Practitioner.birthDate | date | 0..1 |
| Practitioner.photo | Attachment | 0..* |
| Practitioner.qualification | BackboneElement | 0..* |
| Practitioner.qualification.id | string | 0..1 |
| Practitioner.qualification.extension | Extension | 0..* |
| Practitioner.qualification.modifierExtension | Extension | 0..* |
| Practitioner.qualification.identifier | Identifier | 0..* |
| Practitioner.qualification.code | CodeableConcept | 1..1 |
| Practitioner.qualification.period | Period | 0..1 |
| Practitioner.qualification.issuer | Reference(Organization) | 0..1 |
| Practitioner.communication | CodeableConcept | 0..* |
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
StructureDefinition UKCore-PractitionerRole
| Practitioner | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.id | |||
| Short | 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. | ||
| 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 | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.implicitRules | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.contained | |||
| Short | Contained, inline 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. | ||
| 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 |
| ||
| Practitioner.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier | |||
| Short | An identifier that applies to this person in this role. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.active | |||
| Short | Whether this practitioner's record is in active use | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name | |||
| Short | The name(s) associated with the practitioner. | ||
| 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:
| ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.telecom | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.address | |||
| Short | 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. | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.gender | |||
| Short | male | female | other | unknown | ||
| 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. | ||
| Summary | True | ||
| Requirements | Needed to address the person correctly. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.birthDate | |||
| Short | The date on which the practitioner was born | ||
| Definition | The date of birth for the practitioner. | ||
| Cardinality | 0..1 | ||
| Type | date | ||
| Summary | True | ||
| Requirements | Needed for identification. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.photo | |||
| Short | Image of the person | ||
| 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. | ||
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.qualification.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.identifier | |||
| Short | An identifier for this qualification for the practitioner | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.code | |||
| Short | Coded representation of the qualification | ||
| Definition | Coded representation of the qualification. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Specific qualification the practitioner has to provide a service. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.period | |||
| Short | Period during which the qualification is valid | ||
| 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. | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.issuer | |||
| Short | Organization that regulates and issues the qualification | ||
| Definition | Organization that regulates and issues the qualification. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.communication | |||
| Short | A language the practitioner can use in patient 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.
| ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner | 0..* | |
| Practitioner.id | string | 0..1 |
| Practitioner.meta | Meta | 0..1 |
| Practitioner.implicitRules | uri | 0..1 |
| Practitioner.language | code | 0..1 |
| Practitioner.text | Narrative | 0..1 |
| Practitioner.contained | Resource | 0..* |
| Practitioner.extension | Extension | 0..* |
| Practitioner.modifierExtension | Extension | 0..* |
| Practitioner.identifier | Identifier | 0..* |
| Practitioner.active | boolean | 0..1 |
| Practitioner.name | HumanName | 0..* |
| Practitioner.telecom | ContactPoint | 0..* |
| Practitioner.address | Address | 0..* |
| Practitioner.gender | code | 0..1 |
| Practitioner.birthDate | date | 0..1 |
| Practitioner.photo | Attachment | 0..* |
| Practitioner.qualification | BackboneElement | 0..* |
| Practitioner.qualification.id | string | 0..1 |
| Practitioner.qualification.extension | Extension | 0..* |
| Practitioner.qualification.modifierExtension | Extension | 0..* |
| Practitioner.qualification.identifier | Identifier | 0..* |
| Practitioner.qualification.code | CodeableConcept | 1..1 |
| Practitioner.qualification.period | Period | 0..1 |
| Practitioner.qualification.issuer | Reference(Organization) | 0..1 |
| Practitioner.communication | CodeableConcept | 0..* |
Examples
Patient's GP - An example to illustrate the role of General Practitioner.Example UKCore-PractitionerRole-GP
StructureDefinition UKCore-Questionnaire
StructureDefinition UKCore-QuestionnaireResponse
StructureDefinition UKCore-Schedule
| Schedule | |||
| Short | A container for slots of time that may be available for booking appointments | ||
| Definition | A container for slots of time that may be available for booking appointments. | ||
| Cardinality | 0..* | ||
| Alias | Availability | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.id | |||
| Short | 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. | ||
| 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 | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.implicitRules | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.contained | |||
| Short | Contained, inline 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. | ||
| 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 |
| ||
| Schedule.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.identifier | |||
| Short | External Ids for this item | ||
| Definition | External Ids for this item. | ||
| Cardinality | 0..* | ||
| Type | Identifier | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.active | |||
| Short | 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). | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.serviceCategory | |||
| Short | High-level category | ||
| Definition | A broad categorization of the service that is to be performed during this appointment. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | |||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.serviceType | |||
| Short | Specific service | ||
| Definition | The specific service that is to be performed during this appointment. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | |||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.specialty | |||
| Short | Type of specialty needed. | ||
| 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). | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.actor | |||
| Short | 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). | ||
| Cardinality | 1..* | ||
| Type | Reference(Device | HealthcareService | Location | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.planningHorizon | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule.comment | |||
| Short | Comments on availability | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Schedule | 0..* | |
| Schedule.id | string | 0..1 |
| Schedule.meta | Meta | 0..1 |
| Schedule.implicitRules | uri | 0..1 |
| Schedule.language | code | 0..1 |
| Schedule.text | Narrative | 0..1 |
| Schedule.contained | Resource | 0..* |
| Schedule.extension | Extension | 0..* |
| Schedule.modifierExtension | Extension | 0..* |
| Schedule.identifier | Identifier | 0..* |
| Schedule.active | boolean | 0..1 |
| Schedule.serviceCategory | CodeableConcept | 0..* |
| Schedule.serviceType | CodeableConcept | 0..* |
| Schedule.specialty | CodeableConcept | 0..* |
| Schedule.actor | Reference(Device | HealthcareService | Location | Patient | Practitioner | PractitionerRole | RelatedPerson) | 1..* |
| Schedule.planningHorizon | Period | 0..1 |
| Schedule.comment | string | 0..1 |
Examples
An example to illustrate a schedule for immunization appointmentsExample UKCore-Schedule-Immunization
StructureDefinition UKCore-Slot
| Slot | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.id | |||
| Short | 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. | ||
| 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 | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.implicitRules | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.contained | |||
| Short | Contained, inline 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. | ||
| 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 |
| ||
| Slot.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.extension:deliveryChannel | |||
| Short | This describes the delivery channel of a scheduled appointment. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.identifier | |||
| Short | External Ids for this item | ||
| Definition | External Ids for this item. | ||
| Cardinality | 0..* | ||
| Type | Identifier | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.serviceCategory | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | |||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.serviceType | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | |||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.specialty | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Additional details about where the content was created (e.g. clinical specialty). | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.appointmentType | |||
| Short | 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). | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | |||
| Must Support | True | ||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.schedule | |||
| Short | 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. | ||
| Cardinality | 1..1 | ||
| Type | Reference(Schedule) | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.status | |||
| Short | The status of the slot, e.g free, busy, etc. | ||
| Definition | busy | free | busy-unavailable | busy-tentative | entered-in-error. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The free/busy status of the slot. | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.start | |||
| Short | Date/Time that the slot is to begin. | ||
| Definition | Date/Time that the slot is to begin. | ||
| Cardinality | 1..1 | ||
| Type | instant | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.end | |||
| Short | Date/Time that the slot is to conclude. | ||
| Definition | Date/Time that the slot is to conclude. | ||
| Cardinality | 1..1 | ||
| Type | instant | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.overbooked | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Meaning when missing | If overbooked is missing, systems may assume that there are still appointments available | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot.comment | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Slot | 0..* | |
| Slot.id | string | 0..1 |
| Slot.meta | Meta | 0..1 |
| Slot.implicitRules | uri | 0..1 |
| Slot.language | code | 0..1 |
| Slot.text | Narrative | 0..1 |
| Slot.contained | Resource | 0..* |
| Slot.extension | Extension | 0..* |
| Slot.extension:deliveryChannel | Extension | 0..1 |
| Slot.modifierExtension | Extension | 0..* |
| Slot.identifier | Identifier | 0..* |
| Slot.serviceCategory | CodeableConcept | 0..* |
| Slot.serviceType | CodeableConcept | 0..* |
| Slot.specialty | CodeableConcept | 0..* |
| Slot.appointmentType | CodeableConcept | 0..1 |
| Slot.schedule | Reference(Schedule) | 1..1 |
| Slot.status | code | 1..1 |
| Slot.start | instant | 1..1 |
| Slot.end | instant | 1..1 |
| Slot.overbooked | boolean | 0..1 |
| Slot.comment | string | 0..1 |
Examples
An example to illustrate a free / available slot for a walk in vaccinationExample UKCore-Slot-AvailableWalkInVisit
StructureDefinition England-Practitioner
| Practitioner | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.id | |||
| Short | 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. | ||
| 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 | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.implicitRules | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.contained | |||
| Short | Contained, inline 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. | ||
| 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 |
| ||
| Practitioner.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier | |||
| Short | An identifier that applies to this person in this role. | ||
| 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier.type | |||
| Short | Description of identifier | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier.system | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Practitioner.identifier.value | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Practitioner.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number | |||
| Short | An identifier intended for computation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type | |||
| Short | Description of identifier | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.coding | |||
| Short | Code defined by a terminology system | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.coding.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.coding.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.coding.system | |||
| Short | Identity of the terminology 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | http://terminology.hl7.org/CodeSystem/v2-0203 | ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.coding.version | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.coding.code | |||
| Short | 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). | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Summary | True | ||
| Requirements | Need to refer to a particular code in the system. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | MD | ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.coding.display | |||
| Short | Representation defined by the system | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.coding.userSelected | |||
| Short | 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). | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.type.text | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.system | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.hl7.org.uk/Id/gmp-number | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.value | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmp-number.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number | |||
| Short | An identifier intended for computation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type | |||
| Short | Description of identifier | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.coding | |||
| Short | Code defined by a terminology system | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.coding.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.coding.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.coding.system | |||
| Short | Identity of the terminology 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | http://terminology.hl7.org/CodeSystem/v2-0203 | ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.coding.version | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.coding.code | |||
| Short | 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). | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Summary | True | ||
| Requirements | Need to refer to a particular code in the system. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | MD | ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.coding.display | |||
| Short | Representation defined by the system | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.coding.userSelected | |||
| Short | 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). | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.type.text | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.system | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.hl7.org.uk/Id/gmc-number | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.value | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:gmc-number.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:sds-user-id | |||
| Short | An identifier intended for computation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:sds-user-id.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.identifier:sds-user-id.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:sds-user-id.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:sds-user-id.type | |||
| Short | Description of identifier | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:sds-user-id.system | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.nhs.uk/Id/sds-user-id | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Practitioner.identifier:sds-user-id.value | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Practitioner.identifier:sds-user-id.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier:sds-user-id.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.active | |||
| Short | Whether this practitioner's record is in active use | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name | |||
| Short | The name(s) associated with the practitioner. | ||
| 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:
| ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.telecom | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.address | |||
| Short | 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. | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.gender | |||
| Short | male | female | other | unknown | ||
| 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. | ||
| Summary | True | ||
| Requirements | Needed to address the person correctly. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.birthDate | |||
| Short | The date on which the practitioner was born | ||
| Definition | The date of birth for the practitioner. | ||
| Cardinality | 0..1 | ||
| Type | date | ||
| Summary | True | ||
| Requirements | Needed for identification. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.photo | |||
| Short | Image of the person | ||
| 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. | ||
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.qualification.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.identifier | |||
| Short | An identifier for this qualification for the practitioner | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.code | |||
| Short | Coded representation of the qualification | ||
| Definition | Coded representation of the qualification. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Specific qualification the practitioner has to provide a service. | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.period | |||
| Short | Period during which the qualification is valid | ||
| 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. | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.issuer | |||
| Short | Organization that regulates and issues the qualification | ||
| Definition | Organization that regulates and issues the qualification. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.communication | |||
| Short | A language the practitioner can use in patient 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.
| ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner | .. | |
| Practitioner.identifier | 1.. | |
| Practitioner.identifier.system | 1.. | |
| Practitioner.identifier.value | 1.. | |
| Practitioner.identifier:gmp-number | EnglandIdentifierGeneralMedicalPractitionerCode | 0..1 |
| Practitioner.identifier:gmp-number.system | .. | |
| Practitioner.identifier:gmc-number | EnglandIdentifierGeneralMedicalCouncilReferenceNumber | 0..1 |
| Practitioner.identifier:gmc-number.system | .. | |
| Practitioner.identifier:sds-user-id | EnglandIdentifierSDSUserId | 0..1 |
| Practitioner.identifier:sds-user-id.system | .. |
StructureDefinition England-PractitionerRole-Healthcare-Worker
| PractitionerRole | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.id | |||
| Short | 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. | ||
| 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 | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.implicitRules | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.contained | |||
| Short | Contained, inline 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. | ||
| 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 |
| ||
| PractitionerRole.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.identifier | |||
| Short | Business Identifiers that are specific to a role/location | ||
| 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.identifier.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| PractitionerRole.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.identifier.type | |||
| Short | Description of identifier | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.identifier.system | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| PractitionerRole.identifier.value | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| PractitionerRole.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.identifier:sds-user-profile-id | |||
| Short | An identifier intended for computation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.active | |||
| Short | Whether this practitioner role record is in active use. | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.period | |||
| Short | 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. | ||
| 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. | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.period.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| PractitionerRole.period.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.period.start | |||
| Short | Starting time with inclusive boundary | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, per-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.period.end | |||
| Short | 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. | ||
| 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. | ||
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, per-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.practitioner | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Practitioner) | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.practitioner.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| PractitionerRole.practitioner.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.practitioner.reference | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.practitioner.type | |||
| Short | 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). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.practitioner.identifier | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | EnglandIdentifierGeneralMedicalCouncilReferenceNumber, EnglandIdentifierGeneralMedicalPractitionerCode, 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.practitioner.display | |||
| Short | Text alternative for the resource | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.organization | |||
| Short | Organization where the roles are available. | ||
| Definition | The organization where the Practitioner performs the roles associated. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.organization.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| PractitionerRole.organization.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.organization.reference | |||
| Short | 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.organization.type | |||
| Short | 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). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.organization.identifier | |||
| Short | An identifier intended for computation | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.organization.display | |||
| Short | Text alternative for the resource | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.code | |||
| Short | Roles which this practitioner may perform | ||
| 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. | ||
| Summary | True | ||
| Requirements | Need to know what authority the practitioner has - what can they do? | ||
| Comments | A person may have more than one role. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.specialty | |||
| Short | Specific specialty of the practitioner. | ||
| Definition | Specific specialty of the practitioner. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Specific specialty associated with the agency. | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.location | |||
| Short | The location(s) at which this practitioner provides care. | ||
| Definition | The location(s) at which this practitioner provides care. | ||
| Cardinality | 0..* | ||
| Type | Reference(Location) | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.healthcareService | |||
| Short | 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). | ||
| Cardinality | 0..* | ||
| Type | Reference(HealthcareService) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.telecom | |||
| Short | Contact details that are specific to the role/location/service. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Comments | More detailed availability information may be provided in associated Schedule/Slot resources. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| PractitionerRole.availableTime.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.daysOfWeek | |||
| Short | mon | tue | wed | thu | fri | sat | sun | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.allDay | |||
| Short | Always available? e.g. 24 hour service | ||
| Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.availableStartTime | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | time | ||
| Comments | The timezone is expected to be for where this HealthcareService is provided at. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.availableEndTime | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | time | ||
| Comments | The timezone is expected to be for where this HealthcareService is provided at. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable | |||
| Short | 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. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable.id | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| PractitionerRole.notAvailable.extension | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable.description | |||
| Short | 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. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable.during | |||
| Short | Service not available from this date | ||
| Definition | Service is not available (seasonally or for a public holiday) from this date. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availabilityExceptions | |||
| Short | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.endpoint | |||
| Short | 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. | ||
| 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. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole | .. | |
| PractitionerRole.identifier | 1.. | |
| PractitionerRole.identifier.system | 1.. | |
| PractitionerRole.identifier.value | 1.. | |
| PractitionerRole.identifier:sds-user-profile-id | EnglandIdentifierSDSUserProfileId | 1..1 |
| PractitionerRole.period | .. | |
| PractitionerRole.period.start | .. | |
| PractitionerRole.period.end | .. | |
| PractitionerRole.practitioner | .. | |
| PractitionerRole.practitioner.identifier | EnglandIdentifierGeneralMedicalCouncilReferenceNumber, EnglandIdentifierGeneralMedicalPractitionerCode, EnglandIdentifierSDSUserId | 0.. |
| PractitionerRole.organization | .. | |
| PractitionerRole.organization.identifier | EnglandIdentifierOrganisationCode | 1.. |
| PractitionerRole.code | .. |