HdBe-HealthcareOrganization
Profile | Description | Status | URL |
---|---|---|---|
HdBe-HealthcareOrganization | The physical location of a healthcare organization. A healthcare organization is an organization that offers and provides medical, paramedic and/or nursing care to patients/clients. Examples include: hospitals, nursing homes, doctor’s offices. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-HealthcareOrganization |
HdBe-HealthcareOrganization-Organization | The organizational information of a healthcare organization. A healthcare organization is an organization that offers and provides medical, paramedic and/or nursing care to patients/clients. Examples include: hospitals, nursing homes, doctor’s offices. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-HealthcareOrganization-Organization |
HdBe-HealthcareOrganization
Instructions |
---|
HealthcareOrganization is mapped to this Location profile and a profile on Organization (HdBe-HealthcareOrganization-Organization). This Location profile acts as the focal resource of HealthcareOrganization because most references to this CBB are concerned about the recording of the physical location where the care to patient takes place rather than the organizational information. For the latter, the profile on Organization is used which is referenced using the
Healthcare organizations usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this HealthcareOrganization profile using the |
Location | I | Location | Element idLocation HealthcareOrganization / OrganizationLocation Alternate namesOrganisatieLocatie, Zorgaanbieder DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. HealthcareOrganization is mapped to this Location profile and a profile on Organization (HdBe-HealthcareOrganization-Organization). This Location profile acts as the focal resource of HealthcareOrganization because most references to this CBB are concerned about the recording of the physical location where the care to patient takes place rather than the organizational information. For the latter, the profile on Organization is used which is referenced using the
Healthcare organizations usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this HealthcareOrganization profile using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idLocation.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLocation.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idLocation.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ I | 0..* | Identifier | Element idLocation.identifier Unique code or number identifying the location to its users DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. Unordered, Open, by $this(Value) Constraints
|
locationIdentificationNumber | Σ I | 0..1 | IdentifierPattern | Element idLocation.identifier:locationIdentificationNumber LocationIdentificationNumber DefinitionIdentification number of the location, if a numerical location identification is used next to or instead of a location name. The identifier value is equal to the HCOrganization.Site.SiteID (or site number) value as found in the Common Base Registry for HealthCare Actor (CoBRHA). Organization label locations in registries, need to keep track of those.
{ "system": "https://fhir.healthdata.be/NamingSystem/LocationIdentificationNumber" }
|
departmentIdentificationNumber | Σ I | 0..1 | IdentifierPattern | Element idLocation.identifier:departmentIdentificationNumber DepartmentIdentificationNumber DefinitionThe healthcare organization's internal department's identification number ('department' is also referred to as ‘ward’). Organization label locations in registries, need to keep track of those. This needs to be an identification number listed in fair.healthdata.be dataset Internal organization of departments within Belgian healthcare organizations. Please note that this dataset is a temporary solution. A more structured and standardized version will follow in the future, which will then be documented here.
{ "system": "https://fhir.healthdata.be/NamingSystem/DepartmentIdentificationNumber" }
|
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.status active | suspended | inactive DefinitionThe 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. Note that FHIR strings SHALL NOT exceed 1MB in size Indicates whether the location is still in use.
|
operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatus The operational status of the location (typically only for a bed/room) DefinitionThe 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. 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. The operational status if the location (where typically a bed/room).
|
name | Σ | 0..1 | string | Element idLocation.name LocationName Alternate namesLocatieNaam DefinitionName of the location. 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.
|
alias | 0..* | string | There are no (further) constraints on this element Element idLocation.alias A list of alternate names that the location is known as, or was known as, in the past DefinitionA list of alternate names that the location is known as, or was known as, in the past. 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. 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.
| |
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.description Additional details about the location that could be displayed as further information to identify the location beyond its name DefinitionDescription of the Location, which helps in finding or referencing the place. Humans need additional information to verify a correct location has been identified. Note that FHIR strings SHALL NOT exceed 1MB in size
|
mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.mode instance | kind DefinitionIndicates whether a resource instance represents a specific location or a class of locations. 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. 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. Indicates whether a resource instance represents a specific location or a class of locations.
|
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idLocation.type Type of function performed DefinitionIndicates the type of function performed at the location. 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. Indicates the type of function performed at the location.
|
telecom | I | 0..* | HdBe-ContactInformation | Element idLocation.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionThe information needed to contact the healthcare organization via telephone and/or e-mail. Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.
|
address | 0..1 | HdBe-AddressInformation | Element idLocation.address AddressInformation Alternate namesAdresgegevens DefinitionThe physical address of the healthcare organization’s location. If locations can be visited, we need to keep track of their address. The cardinality mismatch with the CBB (0..1 versus 0..*) is explained by the restriction of FHIR to limit the
| |
physicalType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idLocation.physicalType Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. 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. Physical form of the location.
|
position | 0..1 | BackboneElement | There are no (further) constraints on this element Element idLocation.position The absolute geographic location DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). For mobile applications and automated route-finding knowing the exact location of the Location is required.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.position.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitude Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). 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)
| |
latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitude Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). 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)
| |
altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitude Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). 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)
| |
managingOrganization | Σ I | 0..1 | Reference(Organization | HdBe-HealthcareOrganization Organization) | Element idLocation.managingOrganization Organization responsible for provisioning and upkeep DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. 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. Reference(Organization | HdBe-HealthcareOrganization Organization) Constraints
|
partOf | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idLocation.partOf Another Location this one is physically a part of DefinitionAnother Location of which this Location is physically a part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. 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.
|
hoursOfOperation | 0..* | BackboneElement | There are no (further) constraints on this element Element idLocation.hoursOfOperation What days/times during a week is this location usually open DefinitionWhat days/times during a week is this location usually open. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.hoursOfOperation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element idLocation.hoursOfOperation.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week.
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element idLocation.hoursOfOperation.allDay The Location is open all day DefinitionThe Location is open all day.
| |
openingTime | 0..1 | time | There are no (further) constraints on this element Element idLocation.hoursOfOperation.openingTime Time that the Location opens DefinitionTime that the Location opens.
| |
closingTime | 0..1 | time | There are no (further) constraints on this element Element idLocation.hoursOfOperation.closingTime Time that the Location closes DefinitionTime that the Location closes.
| |
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idLocation.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idLocation.endpoint Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. 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. 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.
|
Location | I | Location | Element idLocation HealthcareOrganization / OrganizationLocation Alternate namesOrganisatieLocatie, Zorgaanbieder DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. HealthcareOrganization is mapped to this Location profile and a profile on Organization (HdBe-HealthcareOrganization-Organization). This Location profile acts as the focal resource of HealthcareOrganization because most references to this CBB are concerned about the recording of the physical location where the care to patient takes place rather than the organizational information. For the latter, the profile on Organization is used which is referenced using the
Healthcare organizations usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this HealthcareOrganization profile using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idLocation.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLocation.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idLocation.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ I | 0..* | Identifier | Element idLocation.identifier Unique code or number identifying the location to its users DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. Unordered, Open, by $this(Value) Constraints
|
locationIdentificationNumber | Σ I | 0..1 | IdentifierPattern | Element idLocation.identifier:locationIdentificationNumber LocationIdentificationNumber DefinitionIdentification number of the location, if a numerical location identification is used next to or instead of a location name. The identifier value is equal to the HCOrganization.Site.SiteID (or site number) value as found in the Common Base Registry for HealthCare Actor (CoBRHA). Organization label locations in registries, need to keep track of those.
{ "system": "https://fhir.healthdata.be/NamingSystem/LocationIdentificationNumber" }
|
departmentIdentificationNumber | Σ I | 0..1 | IdentifierPattern | Element idLocation.identifier:departmentIdentificationNumber DepartmentIdentificationNumber DefinitionThe healthcare organization's internal department's identification number ('department' is also referred to as ‘ward’). Organization label locations in registries, need to keep track of those. This needs to be an identification number listed in fair.healthdata.be dataset Internal organization of departments within Belgian healthcare organizations. Please note that this dataset is a temporary solution. A more structured and standardized version will follow in the future, which will then be documented here.
{ "system": "https://fhir.healthdata.be/NamingSystem/DepartmentIdentificationNumber" }
|
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.status active | suspended | inactive DefinitionThe 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. Note that FHIR strings SHALL NOT exceed 1MB in size Indicates whether the location is still in use.
|
operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatus The operational status of the location (typically only for a bed/room) DefinitionThe 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. 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. The operational status if the location (where typically a bed/room).
|
name | Σ | 0..1 | string | Element idLocation.name LocationName Alternate namesLocatieNaam DefinitionName of the location. 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.
|
alias | 0..* | string | There are no (further) constraints on this element Element idLocation.alias A list of alternate names that the location is known as, or was known as, in the past DefinitionA list of alternate names that the location is known as, or was known as, in the past. 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. 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.
| |
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.description Additional details about the location that could be displayed as further information to identify the location beyond its name DefinitionDescription of the Location, which helps in finding or referencing the place. Humans need additional information to verify a correct location has been identified. Note that FHIR strings SHALL NOT exceed 1MB in size
|
mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.mode instance | kind DefinitionIndicates whether a resource instance represents a specific location or a class of locations. 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. 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. Indicates whether a resource instance represents a specific location or a class of locations.
|
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idLocation.type Type of function performed DefinitionIndicates the type of function performed at the location. 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. Indicates the type of function performed at the location.
|
telecom | I | 0..* | HdBe-ContactInformation | Element idLocation.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionThe information needed to contact the healthcare organization via telephone and/or e-mail. Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.
|
address | 0..1 | HdBe-AddressInformation | Element idLocation.address AddressInformation Alternate namesAdresgegevens DefinitionThe physical address of the healthcare organization’s location. If locations can be visited, we need to keep track of their address. The cardinality mismatch with the CBB (0..1 versus 0..*) is explained by the restriction of FHIR to limit the
| |
physicalType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idLocation.physicalType Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. 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. Physical form of the location.
|
position | 0..1 | BackboneElement | There are no (further) constraints on this element Element idLocation.position The absolute geographic location DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). For mobile applications and automated route-finding knowing the exact location of the Location is required.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.position.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitude Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). 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)
| |
latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitude Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). 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)
| |
altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitude Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). 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)
| |
managingOrganization | Σ I | 0..1 | Reference(Organization | HdBe-HealthcareOrganization Organization) | Element idLocation.managingOrganization Organization responsible for provisioning and upkeep DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. 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. Reference(Organization | HdBe-HealthcareOrganization Organization) Constraints
|
partOf | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idLocation.partOf Another Location this one is physically a part of DefinitionAnother Location of which this Location is physically a part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. 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.
|
hoursOfOperation | 0..* | BackboneElement | There are no (further) constraints on this element Element idLocation.hoursOfOperation What days/times during a week is this location usually open DefinitionWhat days/times during a week is this location usually open. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.hoursOfOperation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element idLocation.hoursOfOperation.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week.
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element idLocation.hoursOfOperation.allDay The Location is open all day DefinitionThe Location is open all day.
| |
openingTime | 0..1 | time | There are no (further) constraints on this element Element idLocation.hoursOfOperation.openingTime Time that the Location opens DefinitionTime that the Location opens.
| |
closingTime | 0..1 | time | There are no (further) constraints on this element Element idLocation.hoursOfOperation.closingTime Time that the Location closes DefinitionTime that the Location closes.
| |
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idLocation.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idLocation.endpoint Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. 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. 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.
|
Location | I | Location | Element idLocation HealthcareOrganization / OrganizationLocation Alternate namesOrganisatieLocatie, Zorgaanbieder DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. HealthcareOrganization is mapped to this Location profile and a profile on Organization (HdBe-HealthcareOrganization-Organization). This Location profile acts as the focal resource of HealthcareOrganization because most references to this CBB are concerned about the recording of the physical location where the care to patient takes place rather than the organizational information. For the latter, the profile on Organization is used which is referenced using the
Healthcare organizations usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this HealthcareOrganization profile using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idLocation.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLocation.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idLocation.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ I | 0..* | Identifier | Element idLocation.identifier Unique code or number identifying the location to its users DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. Unordered, Open, by $this(Value) Constraints
|
locationIdentificationNumber | Σ I | 0..1 | IdentifierPattern | Element idLocation.identifier:locationIdentificationNumber LocationIdentificationNumber DefinitionIdentification number of the location, if a numerical location identification is used next to or instead of a location name. The identifier value is equal to the HCOrganization.Site.SiteID (or site number) value as found in the Common Base Registry for HealthCare Actor (CoBRHA). Organization label locations in registries, need to keep track of those.
{ "system": "https://fhir.healthdata.be/NamingSystem/LocationIdentificationNumber" }
|
departmentIdentificationNumber | Σ I | 0..1 | IdentifierPattern | Element idLocation.identifier:departmentIdentificationNumber DepartmentIdentificationNumber DefinitionThe healthcare organization's internal department's identification number ('department' is also referred to as ‘ward’). Organization label locations in registries, need to keep track of those. This needs to be an identification number listed in fair.healthdata.be dataset Internal organization of departments within Belgian healthcare organizations. Please note that this dataset is a temporary solution. A more structured and standardized version will follow in the future, which will then be documented here.
{ "system": "https://fhir.healthdata.be/NamingSystem/DepartmentIdentificationNumber" }
|
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.status active | suspended | inactive DefinitionThe 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. Note that FHIR strings SHALL NOT exceed 1MB in size Indicates whether the location is still in use.
|
operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatus The operational status of the location (typically only for a bed/room) DefinitionThe 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. 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. The operational status if the location (where typically a bed/room).
|
name | Σ | 0..1 | string | Element idLocation.name LocationName Alternate namesLocatieNaam DefinitionName of the location. 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.
|
alias | 0..* | string | There are no (further) constraints on this element Element idLocation.alias A list of alternate names that the location is known as, or was known as, in the past DefinitionA list of alternate names that the location is known as, or was known as, in the past. 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. 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.
| |
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.description Additional details about the location that could be displayed as further information to identify the location beyond its name DefinitionDescription of the Location, which helps in finding or referencing the place. Humans need additional information to verify a correct location has been identified. Note that FHIR strings SHALL NOT exceed 1MB in size
|
mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.mode instance | kind DefinitionIndicates whether a resource instance represents a specific location or a class of locations. 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. 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. Indicates whether a resource instance represents a specific location or a class of locations.
|
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idLocation.type Type of function performed DefinitionIndicates the type of function performed at the location. 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. Indicates the type of function performed at the location.
|
telecom | I | 0..* | HdBe-ContactInformation | Element idLocation.telecom ContactInformation Alternate namesContactpunten, Contactgegevens DefinitionThe information needed to contact the healthcare organization via telephone and/or e-mail. Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps.
|
address | 0..1 | HdBe-AddressInformation | Element idLocation.address AddressInformation Alternate namesAdresgegevens DefinitionThe physical address of the healthcare organization’s location. If locations can be visited, we need to keep track of their address. The cardinality mismatch with the CBB (0..1 versus 0..*) is explained by the restriction of FHIR to limit the
| |
physicalType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idLocation.physicalType Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. 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. Physical form of the location.
|
position | 0..1 | BackboneElement | There are no (further) constraints on this element Element idLocation.position The absolute geographic location DefinitionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). For mobile applications and automated route-finding knowing the exact location of the Location is required.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.position.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitude Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). 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)
| |
latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitude Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). 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)
| |
altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitude Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). 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)
| |
managingOrganization | Σ I | 0..1 | Reference(Organization | HdBe-HealthcareOrganization Organization) | Element idLocation.managingOrganization Organization responsible for provisioning and upkeep DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. 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. Reference(Organization | HdBe-HealthcareOrganization Organization) Constraints
|
partOf | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idLocation.partOf Another Location this one is physically a part of DefinitionAnother Location of which this Location is physically a part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. 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.
|
hoursOfOperation | 0..* | BackboneElement | There are no (further) constraints on this element Element idLocation.hoursOfOperation What days/times during a week is this location usually open DefinitionWhat days/times during a week is this location usually open. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.hoursOfOperation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element idLocation.hoursOfOperation.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week.
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element idLocation.hoursOfOperation.allDay The Location is open all day DefinitionThe Location is open all day.
| |
openingTime | 0..1 | time | There are no (further) constraints on this element Element idLocation.hoursOfOperation.openingTime Time that the Location opens DefinitionTime that the Location opens.
| |
closingTime | 0..1 | time | There are no (further) constraints on this element Element idLocation.hoursOfOperation.closingTime Time that the Location closes DefinitionTime that the Location closes.
| |
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idLocation.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idLocation.endpoint Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. 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. 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.
|
Mapping FHIR profile to CBB
Path | map | CBB |
---|---|---|
Location | HealthcareOrganization | HdBe-HealthcareOrganization |
Location | HealthcareOrganization.OrganizationLocation | HdBe-HealthcareOrganization |
Location.identifier:locationIdentificationNumber | HealthcareOrganization.OrganizationLocation.LocationIdentificationNumber | HdBe-HealthcareOrganization |
Location.identifier:departmentIdentificationNumber | HealthcareOrganization.OrganizationLocation.DepartmentIdentificationNumber | HdBe-HealthcareOrganization |
Location.name | HealthcareOrganization.OrganizationLocation.LocationName | HdBe-HealthcareOrganization |
Location.telecom | HealthcareOrganization.ContactInformation | HdBe-HealthcareOrganization |
Location.address | HealthcareOrganization.AddressInformation | HdBe-HealthcareOrganization |
zib HealthcareOrganization-Location difference
Concept | Category | Description |
---|---|---|
description | textual | Added explanation, in StructureDefinition.description, about how and why the CBB is mapped to two profiles. |
identifier |
element | Added a slice of identifier to map LocationNumber which isn't mapped in the Nictiz profiles. |
identifier |
element | Added DepartmentNumber concept. |
telecom |
reference | Added reference to HdBe-ContactInformation profile, which replaces the two separate HdBe-ContactInformation profiles. |
telecom |
slicing | Removed slicing as the two HdBe-ContactInformation profiles are replaced with one general HdBe-ContactInformation profile, which makes slicing unnecessary. |
telecom |
textual | Removed the comment regarding the cardinality mismatch as this the cardinality is adapted in the CBB as well. |
HdBe-HealthcareOrganization-Organization
Instructions |
---|
HealthcareOrganization is mapped to this Organization profile and a profile on Location (HdBe-HealthcareOrganization). The Location profile acts as the focal resource of HealthcareOrganization because most references to this CBB are concerned about the recording of the physical location where the care to patient/client takes place rather than the organizational information. Often there's no clear distinction between an organizational structure and a physical location. As a rule of thumb, locations are always used for recording where a service occurs, and hence where encounters and observations take place.
Healthcare organizations usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this profile, using the |
Organization | I | Organization | Element idOrganization HealthcareOrganization Alternate namesZorgaanbieder DefinitionA 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. HealthcareOrganization is mapped to this Organization profile and a profile on Location (HdBe-HealthcareOrganization). The Location profile acts as the focal resource of HealthcareOrganization because most references to this CBB are concerned about the recording of the physical location where the care to patient/client takes place rather than the organizational information. Often there's no clear distinction between an organizational structure and a physical location. As a rule of thumb, locations are always used for recording where a service occurs, and hence where encounters and observations take place.
Healthcare organizations usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this profile, using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ I | 0..* | Identifier | Element idOrganization.identifier HealthcareOrganizationIdentificationNumber Alternate namesZorgaanbiederIdentificatienummer DefinitionThe organization’s identification number. For Belgian healthcare organizations, the NIHDI (National Institute for Health and Disability Insurance) and/or the CBE (Crossroads Bank for Enterprises) is used, if possible. Depending on the context other IDs are also possible. For foreign or non-affiliated healthcare organizations, another unique identification number can be used. This must be accompanied by the name and/or code of the issuing organization. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open, by $this(Value) Constraints
|
nidhi | Σ I | 0..* | IdentifierPattern | Element idOrganization.identifier:nidhi Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
{ "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi" }
|
cbe | Σ I | 0..* | IdentifierPattern | Element idOrganization.identifier:cbe Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
{ "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/cbe" }
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.active Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. 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. This resource is generally assumed to be active if no value is provided for the active element
|
type | Σ | 0..* | CodeableConcept | Element idOrganization.type Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. 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. Unordered, Open, by $this(Value) BindingUsed to categorize the organization.
|
departmentSpecialty | Σ | 0..1 | CodeableConceptBinding | Element idOrganization.type:departmentSpecialty DepartmentSpecialty Alternate namesAfdelingSpecialisme DefinitionThe specialty of the healthcare organization’s department. The departmental specialty can be filled in if further indication of the healthcare organization is needed. Need to be able to track the kind of organization that this is - different organization types have different uses. The ValueSet binding strenght deviates from the CBB because the binding strenght must be set to required in order to make the discriminator work. However, the open slice definition allows to extend codes. Used to categorize the organization.
|
organizationType | Σ | 0..1 | CodeableConceptBinding | Element idOrganization.type:organizationType OrganizationType Alternate namesOrganisatieType DefinitionThe type of healthcare organization, such as general hospital, or nursing home. Need to be able to track the kind of organization that this is - different organization types have different uses. The ValueSet binding strenght deviates from the CBB because the binding strenght must be set to required in order to make the discriminator work. However, the open slice definition allows to extend codes. Appropriated terminology codes for OrganizationType are in development and will be bound in a future version. The ValueSet 'OrganizationType' illustrates the purpose of this element. Although the bound concepts will likely be used, the exact codes and system identification is not yet defined. HL7 BE GitHub issue #32 requests to standardize terminology on a federal level for Belgium. Used to categorize the organization.
|
name | Σ I | 0..1 | string | Element idOrganization.name OrganizationName Alternate namesOrganisatieNaam DefinitionName of the organization. If an identification number is given, the name must match the name that corresponds to the identification number. Need to use the name as the label of the organization. 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.
|
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.alias A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. 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. 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.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecom A contact detail for the organization DefinitionA contact detail for the organization. Human contact for the organization. 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.
|
address | I | 0..* | Address | There are no (further) constraints on this element Element idOrganization.address An address for the organization DefinitionAn address for the organization. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
|
partOf | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOf The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. 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.
|
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contact Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purpose The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. 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. The purpose for which you would contact a contact party.
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.name A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name. 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.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecom Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
|
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.address Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements. 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).
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpoint Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. 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. 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.
|
Organization | I | Organization | Element idOrganization HealthcareOrganization Alternate namesZorgaanbieder DefinitionA 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. HealthcareOrganization is mapped to this Organization profile and a profile on Location (HdBe-HealthcareOrganization). The Location profile acts as the focal resource of HealthcareOrganization because most references to this CBB are concerned about the recording of the physical location where the care to patient/client takes place rather than the organizational information. Often there's no clear distinction between an organizational structure and a physical location. As a rule of thumb, locations are always used for recording where a service occurs, and hence where encounters and observations take place.
Healthcare organizations usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this profile, using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ I | 0..* | Identifier | Element idOrganization.identifier HealthcareOrganizationIdentificationNumber Alternate namesZorgaanbiederIdentificatienummer DefinitionThe organization’s identification number. For Belgian healthcare organizations, the NIHDI (National Institute for Health and Disability Insurance) and/or the CBE (Crossroads Bank for Enterprises) is used, if possible. Depending on the context other IDs are also possible. For foreign or non-affiliated healthcare organizations, another unique identification number can be used. This must be accompanied by the name and/or code of the issuing organization. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open, by $this(Value) Constraints
|
nidhi | Σ I | 0..* | IdentifierPattern | Element idOrganization.identifier:nidhi Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
{ "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi" }
|
cbe | Σ I | 0..* | IdentifierPattern | Element idOrganization.identifier:cbe Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
{ "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/cbe" }
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.active Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. 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. This resource is generally assumed to be active if no value is provided for the active element
|
type | Σ | 0..* | CodeableConcept | Element idOrganization.type Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. 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. Unordered, Open, by $this(Value) BindingUsed to categorize the organization.
|
departmentSpecialty | Σ | 0..1 | CodeableConceptBinding | Element idOrganization.type:departmentSpecialty DepartmentSpecialty Alternate namesAfdelingSpecialisme DefinitionThe specialty of the healthcare organization’s department. The departmental specialty can be filled in if further indication of the healthcare organization is needed. Need to be able to track the kind of organization that this is - different organization types have different uses. The ValueSet binding strenght deviates from the CBB because the binding strenght must be set to required in order to make the discriminator work. However, the open slice definition allows to extend codes. Used to categorize the organization.
|
organizationType | Σ | 0..1 | CodeableConceptBinding | Element idOrganization.type:organizationType OrganizationType Alternate namesOrganisatieType DefinitionThe type of healthcare organization, such as general hospital, or nursing home. Need to be able to track the kind of organization that this is - different organization types have different uses. The ValueSet binding strenght deviates from the CBB because the binding strenght must be set to required in order to make the discriminator work. However, the open slice definition allows to extend codes. Appropriated terminology codes for OrganizationType are in development and will be bound in a future version. The ValueSet 'OrganizationType' illustrates the purpose of this element. Although the bound concepts will likely be used, the exact codes and system identification is not yet defined. HL7 BE GitHub issue #32 requests to standardize terminology on a federal level for Belgium. Used to categorize the organization.
|
name | Σ I | 0..1 | string | Element idOrganization.name OrganizationName Alternate namesOrganisatieNaam DefinitionName of the organization. If an identification number is given, the name must match the name that corresponds to the identification number. Need to use the name as the label of the organization. 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.
|
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.alias A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. 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. 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.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecom A contact detail for the organization DefinitionA contact detail for the organization. Human contact for the organization. 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.
|
address | I | 0..* | Address | There are no (further) constraints on this element Element idOrganization.address An address for the organization DefinitionAn address for the organization. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
|
partOf | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOf The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. 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.
|
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contact Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purpose The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. 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. The purpose for which you would contact a contact party.
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.name A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name. 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.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecom Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
|
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.address Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements. 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).
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpoint Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. 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. 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.
|
Organization | I | Organization | Element idOrganization HealthcareOrganization Alternate namesZorgaanbieder DefinitionA 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. HealthcareOrganization is mapped to this Organization profile and a profile on Location (HdBe-HealthcareOrganization). The Location profile acts as the focal resource of HealthcareOrganization because most references to this CBB are concerned about the recording of the physical location where the care to patient/client takes place rather than the organizational information. Often there's no clear distinction between an organizational structure and a physical location. As a rule of thumb, locations are always used for recording where a service occurs, and hence where encounters and observations take place.
Healthcare organizations usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this profile, using the
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ I | 0..* | Identifier | Element idOrganization.identifier HealthcareOrganizationIdentificationNumber Alternate namesZorgaanbiederIdentificatienummer DefinitionThe organization’s identification number. For Belgian healthcare organizations, the NIHDI (National Institute for Health and Disability Insurance) and/or the CBE (Crossroads Bank for Enterprises) is used, if possible. Depending on the context other IDs are also possible. For foreign or non-affiliated healthcare organizations, another unique identification number can be used. This must be accompanied by the name and/or code of the issuing organization. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Unordered, Open, by $this(Value) Constraints
|
nidhi | Σ I | 0..* | IdentifierPattern | Element idOrganization.identifier:nidhi Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
{ "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi" }
|
cbe | Σ I | 0..* | IdentifierPattern | Element idOrganization.identifier:cbe Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
{ "system": "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/cbe" }
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.active Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. 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. This resource is generally assumed to be active if no value is provided for the active element
|
type | Σ | 0..* | CodeableConcept | Element idOrganization.type Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. 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. Unordered, Open, by $this(Value) BindingUsed to categorize the organization.
|
departmentSpecialty | Σ | 0..1 | CodeableConceptBinding | Element idOrganization.type:departmentSpecialty DepartmentSpecialty Alternate namesAfdelingSpecialisme DefinitionThe specialty of the healthcare organization’s department. The departmental specialty can be filled in if further indication of the healthcare organization is needed. Need to be able to track the kind of organization that this is - different organization types have different uses. The ValueSet binding strenght deviates from the CBB because the binding strenght must be set to required in order to make the discriminator work. However, the open slice definition allows to extend codes. Used to categorize the organization.
|
organizationType | Σ | 0..1 | CodeableConceptBinding | Element idOrganization.type:organizationType OrganizationType Alternate namesOrganisatieType DefinitionThe type of healthcare organization, such as general hospital, or nursing home. Need to be able to track the kind of organization that this is - different organization types have different uses. The ValueSet binding strenght deviates from the CBB because the binding strenght must be set to required in order to make the discriminator work. However, the open slice definition allows to extend codes. Appropriated terminology codes for OrganizationType are in development and will be bound in a future version. The ValueSet 'OrganizationType' illustrates the purpose of this element. Although the bound concepts will likely be used, the exact codes and system identification is not yet defined. HL7 BE GitHub issue #32 requests to standardize terminology on a federal level for Belgium. Used to categorize the organization.
|
name | Σ I | 0..1 | string | Element idOrganization.name OrganizationName Alternate namesOrganisatieNaam DefinitionName of the organization. If an identification number is given, the name must match the name that corresponds to the identification number. Need to use the name as the label of the organization. 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.
|
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization.alias A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. 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. 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.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecom A contact detail for the organization DefinitionA contact detail for the organization. Human contact for the organization. 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.
|
address | I | 0..* | Address | There are no (further) constraints on this element Element idOrganization.address An address for the organization DefinitionAn address for the organization. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
|
partOf | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.partOf The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. 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.
|
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization.contact Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purpose The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. 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. The purpose for which you would contact a contact party.
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.name A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name. 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.
| |
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecom Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email.
|
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.address Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements. 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).
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpoint Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. 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. 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.
|
Mapping FHIR profile to CBB
Path | map | CBB |
---|---|---|
Organization | HealthcareOrganization | HdBe-HealthcareOrganization |
Organization.identifier | HealthcareOrganizationIdentificationNumber | HdBe-HealthcareOrganization |
Organization.type:departmentSpecialty | DepartmentSpecialty | HdBe-HealthcareOrganization |
Organization.type:organizationType | OrganizationType | HdBe-HealthcareOrganization |
Organization.name | OrganizationName | HdBe-HealthcareOrganization |
A UML overview at the bottom of this page provides an example of how a hierarchical structure is initialized in FHIR using Organization and Location resources.
zib HealthcareOrganization-Organization difference
Concept | Category | Description |
---|---|---|
description | textual | Added explanation, in StructureDefinition.description, about how and why the CBB is mapped to two profiles. |
identifier |
slicing | Replaced (URA, AGB) slices with NIDHI and CBE. |
identifier |
textual | Removed Dutch context of the URA and AGB identifiers on the root identifer. |
DepartmentSpecialty |
textual | Removed the Dutch context. |
OrganizationType |
textual | Removed the Dutch context. |
OrganizationType |
terminology | Replaced ValueSet OrganizationType codes with terminology based on a one-time export of HCO_TYPE as found in the Common Base Registry for HealthCare Actor (CoBRHA). These codes are placed in the healthdata.be namespace. HL7 BE GitHub issue #32 requests to standardize terminology on a federal level for Belgium. |
Terminology Bindings
Path | Name | Strength | URL | ConceptMap |
---|---|---|---|---|
Organization.type | DepartmentSpecialty | required | https://fhir.healthdata.be/ValueSet/DepartmentSpecialty | No bound ConceptMap |
Organization.type | OrganizationType | required | https://fhir.healthdata.be/ValueSet/OrganizationType | No bound ConceptMap |
NamingSystems
Name | Kind | Description | UniqueId |
---|---|---|---|
DepartmentIdentificationNumber | identifier | This NamingSytem defines an identifier system to identify internal organization departments. The identifier value is equal to the department identification number as found in the fair.healthdata.be dataset named: Internal organization of departments within Belgian healthcare organizations. Please note that this dataset is a temporary solution. A more structured and standardized version will follow in the future, which will then be documented here. | https://fhir.healthdata.be/NamingSystem/DepartmentIdentificationNumber |
LocationIdentificationNumber | identifier | This NamingSytem defines an identifier system to identify healthcare organizations' physical locations. The identifier value is equal to the HCOrganization.Site.SiteID (or site number) value as found in the Common Base Registry for HealthCare Actor (CoBRHA). | https://fhir.healthdata.be/NamingSystem/LocationIdentificationNumber |
A UML example of a hierarchical structure initialized in FHIR resources
Please note: that he UML is splitst into two for readability purposes. The first UML demonstrates profoundly the Location hierarchical structure. The second UML shows how each instance of the Location hierachy can also refer to the Organization hierachy.
The locationId, departmentId and nihdi are all mapped to their approriate slice on .identifier
.