NotifiedPersonFacility (Organization) | C | | Organization | There are no (further) constraints on this element Element idOrganization Short descriptionA grouping of people or organizations with a common purpose 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.
Data typeOrganization Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
(identifier.count() + name.count()) > 0 Mappings- rim: Entity. Role, or Act
- v2: (also see master files messages)
- rim: Organization(classCode=ORG, determinerCode=INST)
- servd: Organization
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization.meta Short descriptionMetadata 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.
Data typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.implicitRules Short descriptionA 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.
CommentsAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization.text Short descriptionText 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.
CommentsContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Data typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idOrganization.contained Short descriptionContained, 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.
CommentsThis should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Data typeResource Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.extension Short descriptionAdditional 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.modifierExtension Short descriptionExtensions 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).
RequirementsModifier 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | Σ C | 0..* | Identifier | There are no (further) constraints on this element Element idOrganization.identifier Short descriptionIdentifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems.
RequirementsOrganizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Data typeIdentifier ConditionsThe cardinality or value of this element may be affected by these constraints: org-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.identifier
- v2: XON.10 / XON.3
- rim: .scopes[Role](classCode=IDENT)
- servd: ./Identifiers
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.active Short descriptionWhether the organization's record is still in active use DefinitionWhether the organization's record is still in active use.
RequirementsNeed a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.
CommentsThis active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.
This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Meaning when missingThis resource is generally assumed to be active if no value is provided for the active element
Data typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.status
- v2: No equivalent in HL7 v2
- rim: .status
- servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
|
type | Σ | 0..* | CodeableConcept | Element idOrganization.type Short descriptionArt der Einrichtung DefinitionArt der Einrichtung. Der Wert muss entsprechend des vom RKI definierten ValueSets (https://demis.rki.de/fhir/ValueSet/organizationType) im coding Element dargestellt werden.
RequirementsNeed to be able to track the kind of organization that this is - different organization types have different uses.
CommentsOrganizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes
When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.
We expect that some jurisdictions will profile this optionality to be a single cardinality.
Data typeCodeableConcept BindingUsed to categorize the organization.
OrganizationType (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.class
- v2: No equivalent in v2
- rim: .code
- servd: n/a
|
id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.type.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.type.extension Short descriptionAdditional 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
coding | Σ | 1..1 | CodingBinding | Element idOrganization.type.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
RequirementsAllows for alternative encodings within a code system, and translations to other code systems.
CommentsCodes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data typeCoding BindingOrganizationType (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.type.coding.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.type.coding.extension Short descriptionAdditional 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idOrganization.type.coding.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
RequirementsNeed to be unambiguous about the source of the definition of the symbol.
CommentsThe URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.type.coding.version Short descriptionVersion of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
CommentsWhere the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idOrganization.type.coding.code Short descriptionSymbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
RequirementsNeed to refer to a particular code in the system.
Data typecode Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.type.coding.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
RequirementsNeed to be able to carry a human-readable meaning of the code for readers that do not know the system.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idOrganization.type.coding.userSelected Short descriptionIf this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
RequirementsThis has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
CommentsAmongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Data typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
text | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.type.text Short descriptionPlain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
RequirementsThe codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
CommentsVery often the text is the same as a displayName of one of the codings.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
name | Σ C | 0..1 | string | Element idOrganization.name Short descriptionEinrichtungsname DefinitionRequirementsNeed to use the name as the label of the organization.
CommentsIf the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: org-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XON.1
- rim: .name
- servd: .PreferredName/Name
|
alias | | 0..* | string | There are no (further) constraints on this element Element idOrganization.alias Short descriptionA 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.
RequirementsOver 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.
CommentsThere are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
telecom | C | 0..* | ContactPoint | Element idOrganization.telecom Short descriptionKontaktangaben der Betroffenen Person DefinitionKontaktangaben der Betroffenen Person. Telefonnummern oder E-Mailadressen können angegeben werden.
RequirementsHuman contact for the organization.
CommentsThe use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
Data typeContactPoint SlicingUnordered, Closed, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: org-3 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty() Mappings- v2: ORC-22?
- rim: .telecom
- servd: ./ContactPoints
|
Email | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecom:Email Short descriptionA contact detail for the organization DefinitionA contact detail for the organization.
RequirementsHuman contact for the organization.
CommentsThe use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
Data typeContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: org-3 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty() Mappings- v2: ORC-22?
- rim: .telecom
- servd: ./ContactPoints
|
id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.telecom:Email.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.telecom:Email.extension Short descriptionAdditional 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
system | Σ C | 1..1 | codeBindingFixed Value | Element idOrganization.telecom:Email.system Short descriptionphone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
Data typecode BindingTelecommunications form for contact point.
ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Fixed valueemail Mappings- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.telecom:Email.value Short descriptionThe actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
RequirementsNeed to support legacy numbers that are not in a tightly controlled format.
CommentsAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.1 (or XTN.12)
- rim: ./url
- servd: ./Value
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.telecom:Email.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
RequirementsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
CommentsApplications can assume that a contact is current unless it explicitly says that it is temporary or old.
Data typecode BindingContactPointUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.2 - but often indicated by field
- rim: unique(./use)
- servd: ./ContactPointPurpose
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idOrganization.telecom:Email.rank Short descriptionSpecify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
CommentsNote that rank does not necessarily follow the order in which the contacts are represented in the instance.
Data typepositiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.telecom:Email.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
Phone | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecom:Phone Short descriptionA contact detail for the organization DefinitionA contact detail for the organization.
RequirementsHuman contact for the organization.
CommentsThe use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
Data typeContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: org-3 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty() Mappings- v2: ORC-22?
- rim: .telecom
- servd: ./ContactPoints
|
id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.telecom:Phone.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | Element idOrganization.telecom:Phone.extension Short descriptionAdditional 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
system | Σ C | 1..1 | codeBindingFixed Value | Element idOrganization.telecom:Phone.system Short descriptionphone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
Data typecode BindingTelecommunications form for contact point.
ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Fixed valuephone Mappings- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.telecom:Phone.value Short descriptionThe actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
RequirementsNeed to support legacy numbers that are not in a tightly controlled format.
CommentsAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.1 (or XTN.12)
- rim: ./url
- servd: ./Value
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.telecom:Phone.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
RequirementsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
CommentsApplications can assume that a contact is current unless it explicitly says that it is temporary or old.
Data typecode BindingContactPointUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.2 - but often indicated by field
- rim: unique(./use)
- servd: ./ContactPointPurpose
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idOrganization.telecom:Phone.rank Short descriptionSpecify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
CommentsNote that rank does not necessarily follow the order in which the contacts are represented in the instance.
Data typepositiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.telecom:Phone.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
address | C | 0..* | AddressDeBasis | Element idOrganization.address Short descriptionEinrichtungsaddresse DefinitionRequirementsMay need to keep track of the organization's addresses for contacting, billing or reporting requirements.
CommentsNote: 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).
Data typeAddressDeBasis ConditionsThe cardinality or value of this element may be affected by these constraints: org-2, ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - org-2: An address of an organization can never be of use 'home'
where(use = 'home').empty() - add-1: Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()) - add-2: Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()) - add-3: Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) - add-4: Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein.
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty() - add-5: Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()) - add-6: Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty())) - add-7: Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein.
extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or line.where(extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').valueString=$this).exists() Examples Beispiel für einfache Adresse{
"use": "home",
"type": "postal",
"line": [
"Musterweg 42"
],
"city": "Musterhausen",
"postalCode": "99999"
} Mappings- v2: ORC-23?
- rim: .address
- servd: ./PrimaryAddress and ./OtherAddresses
- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
|
id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.address.extension Short descriptionAdditional 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
Stadtteil | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idOrganization.address.extension:Stadtteil Short descriptionStadt- oder Ortsteil Alternate namesextensions, user content DefinitionA subsection of a municipality.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: n/a
- rim: ADXP[partType=PRE]
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.address.use Short descriptionhome | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address.
RequirementsAllows an appropriate address to be chosen from a list of many.
CommentsApplications can assume that an address is current unless it explicitly says that it is temporary or old.
Data typecode BindingAddressUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples Generalhome Mappings- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization.address.type Short descriptionpostal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
CommentsThe definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
Data typecode BindingThe type of an address (physical / postal).
AddressType (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples Generalboth Mappings- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
- BDT: 1202 (1=physical, 2=postal)
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.text Short descriptionText representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
RequirementsA renderable, unencoded form.
CommentsCan provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General137 Nowhere Street, Erewhon 9132 Mappings- v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim: ./formatted
- vcard: address label parameter
|
line | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.address.line Short descriptionStraßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung DefinitionDiese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden.
Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und HausnummerMusterweg 42 Mappings- v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
- rim: AD.part[parttype = AL]
- vcard: street
- servd: ./StreetAddress (newline delimitted)
- KVDT: 3107 + 3109 + 3115 oder 3123
- BDT: 3107 + 3109 + 3115 oder 3123
|
id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.line.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references)
Data typestring |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.address.line.extension Short descriptionAdditional 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
Strasse | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idOrganization.address.line.extension:Strasse Short descriptionStrassenname (ohne Hausnummer) Alternate namesextensions, user content DefinitionStrassenname (ohne Hausnummer)
Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: ADXP[partType=STR]
- KVDT: 3107
- BDT: 3107
|
Hausnummer | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idOrganization.address.line.extension:Hausnummer Short descriptionHausnummer Alternate namesextensions, user content DefinitionHausnummer, sowie Zusätze (Appartmentnummer, Etage...)
Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: ADXP[partType=BNR]
- KVDT: 3109
- BDT: 3109
|
Adresszusatz | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idOrganization.address.line.extension:Adresszusatz Short descriptionAdresszusatz Alternate namesextensions, user content DefinitionZusätzliche Informationen, wie z.B. "3. Etage", "Appartment C"
Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: ADXP[partType=ADL]
- KVDT: 3115
- BDT: 3115
|
Postfach | C | 0..0 | Extension(string) | Element idOrganization.address.line.extension:Postfach Short descriptionPostfach Alternate namesextensions, user content DefinitionPostfach-Adresse.
Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Eine Postfach-Adresse darf nicht in Verbindung mit Address.type "physical" oder "both" verwendet werden.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings- rim: ADXP[partType=POB]
- KVDT: 3123
- BDT: 3123
|
value | | 0..1 | System.String | There are no (further) constraints on this element Element idOrganization.address.line.value Short descriptionPrimitive value for string DefinitionData typeSystem.String Maximum string length1048576 |
city | Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.address.city Short descriptionName of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples GeneralErewhon Mappings- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
- BDT: 3113 oder 3122 (Postfach)
- KVDT: 3113 oder 3122 (Postfach)
|
district | Σ | 0..0 | string | There are no (further) constraints on this element Element idOrganization.address.district Short descriptionDistrict name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county).
CommentsDistrict is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples GeneralMadison Mappings- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
state | Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element idOrganization.address.state Short descriptionBundesland Alternate namesProvince, Territory DefinitionName (oder Kürzel) des Bundeslandes.
Data typestring BindingISO31662DE (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
postalCode | Σ | 1..1 | stringBinding | Element idOrganization.address.postalCode Short descriptionPostleitzahl Alternate namesZip DefinitionPostleitzahl gemäß der im jeweiligen Land gültigen Konventionen
Data typestring BindingPostalCode (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General9132 Mappings- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
- BDT: 3112 oder 3121 (Postfach)
- KVDT: 3112 oder 3121 (Postfach)
|
country | Σ | 1..1 | stringBinding | Element idOrganization.address.country Short descriptionStaat DefinitionStaat (vorzugsweise als 2-Stelliger ISO-Ländercode).
Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben
CommentsISO 3166 3 letter codes can be used in place of a human readable country name.
Data typestring BindingCountry (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
- BDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
- KVDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.address.period Short descriptionTime period when address was/is in use DefinitionTime period when address was/is in use.
RequirementsAllows addresses to be placed in historical context.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General{
"start": "2010-03-23",
"end": "2010-07-01"
} Mappings- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.period.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.address.period.extension Short descriptionAdditional 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idOrganization.address.period.start Short descriptionStarting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive.
CommentsIf the low element is missing, the meaning is that the low boundary is not known.
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: DR.1
- rim: ./low
- BDT: 8226
|
end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idOrganization.address.period.end Short descriptionEnd time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
CommentsThe high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Meaning when missingIf the end of the period is missing, it means that the period is ongoing
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: DR.2
- rim: ./high
- BDT: 8227
|
partOf | Σ | 0..1 | Reference(Organization) | Element idOrganization.partOf Short descriptionÜbergeordnete Einrichtung, zu der diese Einrichtung gehört DefinitionÜbergeordnete Einrichtung, zu der diese Einrichtung gehört
RequirementsNeed to be able to track the hierarchy of organizations within an organization.
Data typeReference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: No equivalent in HL7 v2
- rim: .playedBy[classCode=Part].scoper
- servd: n/a
|
contact | | 0..* | BackboneElement | Element idOrganization.contact Short descriptionAnsprechpartner der Einrichtung DefinitionAnsprechpartner der Einrichtung
RequirementsNeed to keep track of assigned contact points within bigger organization.
CommentsWhere multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.contact.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.extension Short descriptionAdditional 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.contact.modifierExtension Short descriptionExtensions 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).
RequirementsModifier 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.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
purpose | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization.contact.purpose Short descriptionThe type of contact DefinitionIndicates a purpose for which the contact can be reached.
RequirementsNeed to distinguish between multiple contact persons.
Data typeCodeableConcept BindingThe purpose for which you would contact a contact party.
ContactEntityType (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
name | | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization.contact.name Short descriptionA name associated with the contact DefinitionA name associated with the contact.
RequirementsNeed to be able to track the person by name.
Data typeHumanName Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-5, PID-9
- rim: ./name
|
telecom | | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.contact.telecom Short descriptionContact 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.
RequirementsPeople have (primary) ways to contact them in some way such as phone, email.
Data typeContactPoint Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-13, PID-14
- rim: ./telecom
|
address | | 0..1 | Address | There are no (further) constraints on this element Element idOrganization.contact.address Short descriptionVisiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact.
RequirementsMay need to keep track of a contact party's address for contacting, billing or reporting requirements.
Data typeAddress Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
endpoint | | 0..0 | Reference(Endpoint) | There are no (further) constraints on this element Element idOrganization.endpoint Short descriptionTechnical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization.
RequirementsOrganizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
Data typeReference(Endpoint) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |