This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-vhdir-organizationRole Profile.
OrganizationRole | |
Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. |
Control | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
OrganizationRole.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Must Support | 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. |
OrganizationRole.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Must Support | true |
OrganizationRole.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
OrganizationRole.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
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). |
OrganizationRole.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Must Support | true |
Alternate Names | 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 in formation is added later. |
OrganizationRole.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | 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. |
OrganizationRole.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
OrganizationRole.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | 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. |
OrganizationRole.identifier | |
Definition | Business Identifiers that are specific to a role/location. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Often, specific identities are assigned for the agent. |
OrganizationRole.identifier.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.identifier.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
OrganizationRole.identifier.extension (http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status) | |
Definition | Describes the status of an identifier |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: code) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
OrganizationRole.identifier.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.identifier.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
OrganizationRole.identifier.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 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/ig/vhdir/StructureDefinition/identifier-status |
OrganizationRole.identifier.extension.valueCode(valueCode) | |
Definition | Describes the status of an identifier |
Control | 0..1 |
Type | code |
OrganizationRole.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | Identifies the purpose for this identifier, if known . The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
OrganizationRole.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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. |
OrganizationRole.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Control | 0..1 |
Type | uri |
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. |
Example | General:http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
OrganizationRole.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 0..1 |
Type | string |
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. |
Example | General:123456 |
OrganizationRole.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
OrganizationRole.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Reference(Organization) |
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. |
OrganizationRole.active | |
Definition | Whether this practitioner role record is in active use. |
Control | 0..1 |
Type | boolean |
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 | Default is true. 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. |
Default Value | true |
OrganizationRole.period | |
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
Control | 0..1 |
Type | Period |
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. |
OrganizationRole.organization | |
Definition | The organization where the Practitioner performs the roles associated. |
Control | 0..1 |
Type | Reference(Organization) |
OrganizationRole.participatingOrganization | |
Definition | Practitioner that is able to provide the defined services for the organization. |
Control | 0..1 |
Type | Reference(Organization) |
OrganizationRole.network | |
Definition | The network(s) this association applies to (if any). |
Control | 0..* |
Type | Reference(Organization) |
OrganizationRole.code | |
Definition | Roles which this practitioner is authorized to perform for the organization. |
Control | 0..* |
Binding | The role a person plays representing an organization For example codes, see OrganizationRole |
Type | CodeableConcept |
Requirements | Need to know what authority the practitioner has - what can they do? |
Comments | A person may have more than one role. At least one role is required. |
OrganizationRole.specialty | |
Definition | Specific specialty of the practitioner. |
Control | 0..* |
Binding | Specific specialty associated with the agency The codes SHOULD be taken from Practice Setting Code Value Set |
Type | CodeableConcept |
OrganizationRole.location | |
Definition | The location(s) at which this practitioner provides care. |
Control | 0..* |
Type | Reference(Location) |
OrganizationRole.healthcareService | |
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s). |
Control | 0..* |
Type | Reference(HealthcareService) |
OrganizationRole.telecom | |
Definition | Contact details that are specific to the role/location/service. |
Control | 0..* |
Type | ContactPoint |
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. |
OrganizationRole.telecom.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.telecom.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
OrganizationRole.telecom.extension (http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime) | |
Definition | Time period when the contact point is to be used |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Dosage, ContactDetail, Contributor, DataRequirement, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Meta) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
OrganizationRole.telecom.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.telecom.extension.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
OrganizationRole.telecom.extension.extension(daysOfWeek) | |
Definition | Days of the week - mon|tue|wed|thu|fri|sat|sun |
Control | 0..* |
Type | Extension |
OrganizationRole.telecom.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.telecom.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
OrganizationRole.telecom.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 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 | daysOfWeek |
OrganizationRole.telecom.extension.extension.valueCode(valueCode) | |
Definition | Days of the week - mon|tue|wed|thu|fri|sat|sun |
Control | 0..1 |
Type | code |
OrganizationRole.telecom.extension.extension(allDay) | |
Definition | Always available? e.g. 24 hour service |
Control | 0..1 |
Type | Extension |
OrganizationRole.telecom.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.telecom.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
OrganizationRole.telecom.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 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 | allDay |
OrganizationRole.telecom.extension.extension.valueBoolean(valueBoolean) | |
Definition | Always available? e.g. 24 hour service |
Control | 0..1 |
Type | boolean |
OrganizationRole.telecom.extension.extension(availableStartTime) | |
Definition | Opening time of day (ignored if allDay = true) |
Control | 0..1 |
Type | Extension |
OrganizationRole.telecom.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.telecom.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
OrganizationRole.telecom.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 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 | availableStartTime |
OrganizationRole.telecom.extension.extension.valueTime(valueTime) | |
Definition | Opening time of day (ignored if allDay = true) |
Control | 0..1 |
Type | time |
OrganizationRole.telecom.extension.extension(availableEndTime) | |
Definition | Closing time of day (ignored if allDay = true) |
Control | 0..1 |
Type | Extension |
OrganizationRole.telecom.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.telecom.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
OrganizationRole.telecom.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 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 | availableEndTime |
OrganizationRole.telecom.extension.extension.valueTime(valueTime) | |
Definition | Closing time of day (ignored if allDay = true) |
Control | 0..1 |
Type | time |
OrganizationRole.telecom.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 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/ig/vhdir/StructureDefinition/contactPoint-availableTime |
OrganizationRole.telecom.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..0 |
Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Dosage, ContactDetail, Contributor, DataRequirement, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Meta |
[x] Note | See Choice of Data Types for further information about how to use [x] |
OrganizationRole.telecom.extension (http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary) | |
Definition | Represents an external point of contact responsible for handling communications with this entity |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
OrganizationRole.telecom.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Control | 0..1 This element is affected by the following invariants: cpt-2 |
Binding | Telecommunications form for contact point The codes SHALL be taken from ContactPointSystem |
Type | code |
OrganizationRole.telecom.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Control | 0..1 |
Type | string |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
OrganizationRole.telecom.use | |
Definition | Identifies the purpose for the contact point. |
Control | 0..1 |
Binding | Use of contact point The codes SHALL be taken from ContactPointUse |
Type | code |
Is Modifier | true |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
OrganizationRole.telecom.rank | |
Definition | Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. |
Control | 0..1 |
Type | positiveInt |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
OrganizationRole.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Control | 0..1 |
Type | Period |
OrganizationRole.availableTime | |
Definition | A collection of times that the Service Site is available. |
Control | 0..* |
Type | BackboneElement |
Comments | More detailed availability information may be provided in associated Schedule/Slot resources. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
OrganizationRole.availableTime.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.availableTime.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
OrganizationRole.availableTime.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
OrganizationRole.availableTime.daysOfWeek | |
Definition | Indicates which days of the week are available between the start and end Times. |
Control | 0..* |
Binding | The days of the week. The codes SHALL be taken from DaysOfWeek |
Type | code |
OrganizationRole.availableTime.allDay | |
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. |
Control | 0..1 |
Type | boolean |
OrganizationRole.availableTime.availableStartTime | |
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored. |
Control | 0..1 |
Type | time |
Comments | The timezone is expected to be for where this HealthcareService is provided at. |
OrganizationRole.availableTime.availableEndTime | |
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored. |
Control | 0..1 |
Type | time |
Comments | The timezone is expected to be for where this HealthcareService is provided at. |
OrganizationRole.notAvailable | |
Definition | The HealthcareService is not available during this period of time due to the provided reason. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
OrganizationRole.notAvailable.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
OrganizationRole.notAvailable.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
OrganizationRole.notAvailable.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
OrganizationRole.notAvailable.description | |
Definition | The reason that can be presented to the user as to why this time is not available. |
Control | 1..1 |
Type | string |
OrganizationRole.notAvailable.during | |
Definition | Service is not available (seasonally or for a public holiday) from this date. |
Control | 0..1 |
Type | Period |
OrganizationRole.availabilityExceptions | |
Definition | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. |
Control | 0..1 |
Type | string |
OrganizationRole.endpoint | |
Definition | Technical endpoints providing access to services operated for the practitioner with this role. |
Control | 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. |