| EmigaPublicHealthOrganization (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.
Organization Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - 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 | id | 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.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
id 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())
Mappings |
| meta | S Σ | 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.
Meta 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())
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.meta.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.meta.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idOrganization.meta.versionId Short descriptionVersion specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
id 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())
Mappings |
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idOrganization.meta.lastUpdated Short descriptionWhen the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
instant 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())
Mappings |
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idOrganization.meta.source Short descriptionIdentifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.
This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
uri 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())
Mappings |
| profile | S Σ | 1..* | canonical(StructureDefinition) | Element idOrganization.meta.profile Short descriptionProfiles this resource claims to conform to DefinitionCommentsIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
canonical(StructureDefinition) SlicingUnordered, Open, by $this(Value) 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())
Mappings |
| emigaprofile | S Σ | 1..1 | canonical(StructureDefinition)Pattern | Element idOrganization.meta.profile:emigaprofile Short descriptionProfiles this resource claims to conform to DefinitionCommentsIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
canonical(StructureDefinition) 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())
Patternhttps://emiga.rki.de/fhir/vzd/StructureDefinition/EmigaPublicHealthOrganization Mappings |
| security | S Σ | 2..* | CodingBinding | Element idOrganization.meta.security Short descriptionSecurity Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding SlicingUnordered, Open, by system(Value) Slicing security attribute by coding system BindingSecurity Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) 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())
Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| visibility | S Σ | 1..1 | CodingBinding | Element idOrganization.meta.security:visibility Short descriptionSecurity Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding BindingSecurity Labels from the Healthcare Privacy and Security Classification System. EinrVResourceVisibilityTypeVS (required) 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())
Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.meta.security:visibility.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.meta.security:visibility.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| system | S Σ | 1..1 | uriPattern | Element idOrganization.meta.security:visibility.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Need to be unambiguous about the source of the definition of the symbol.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
uri 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())
Patternhttps://emiga.rki.de/fhir/common/CodeSystem/ResourceVisibilityType Mappings- rim: n/a
- 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.meta.security:visibility.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.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
string 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())
Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idOrganization.meta.security:visibility.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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code 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())
Mappings- rim: n/a
- 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.meta.security:visibility.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
string 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())
Mappings- rim: n/a
- 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.meta.security:visibility.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).
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
boolean 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())
Mappings- rim: n/a
- 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 ]
|
| responsibility | S Σ | 1..1 | CodingBinding | Element idOrganization.meta.security:responsibility Short descriptionSecurity Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding BindingSecurity Labels from the Healthcare Privacy and Security Classification System. ResourceResponsibility (required) 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())
Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.meta.security:responsibility.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.meta.security:responsibility.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| system | S Σ | 1..1 | uriPattern | Element idOrganization.meta.security:responsibility.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Need to be unambiguous about the source of the definition of the symbol.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
uri 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())
Patternhttps://emiga.rki.de/fhir/common/CodeSystem/ResourceResponsibility Mappings- rim: n/a
- 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.meta.security:responsibility.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.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
string 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())
Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idOrganization.meta.security:responsibility.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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code 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())
Mappings- rim: n/a
- 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.meta.security:responsibility.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
string 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())
Mappings- rim: n/a
- 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.meta.security:responsibility.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).
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
boolean 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())
Mappings- rim: n/a
- 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 ]
|
| tag | S Σ | 0..* | Coding | Element idOrganization.meta.tag Short descriptionTags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding SlicingUnordered, Open, by system(Pattern) BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example) 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())
Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| relevance | S Σ | 0..* | CodingBinding | Element idOrganization.meta.tag:relevance Short descriptionTags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Relevance (required) 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())
Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.meta.tag:relevance.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.meta.tag:relevance.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| system | S Σ | 1..1 | uriPattern | Element idOrganization.meta.tag:relevance.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Need to be unambiguous about the source of the definition of the symbol.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
uri 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())
Patternhttps://emiga.rki.de/fhir/common/CodeSystem/Relevance Mappings- rim: n/a
- 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.meta.tag:relevance.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.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
string 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())
Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idOrganization.meta.tag:relevance.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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code 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())
Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | S Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.meta.tag:relevance.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
string 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())
Mappings- rim: n/a
- 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.meta.tag:relevance.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).
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
boolean 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())
Mappings- rim: n/a
- 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 ]
|
| implicitRules | Σ ?! | 0..0 | 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.
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.
uri 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())
Mappings |
| 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.
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).
code BindingA human language. CommonLanguages (preferred) Binding extensionsConditionsThe 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())
Mappings |
| text | | 0..0 | 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.
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.
Narrative 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())
Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..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.
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.
Resource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | S C | 1..* | 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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| responsibilityHealthdepartments | S C | 1..* | Extension(Complex) | Element idOrganization.extension:responsibilityHealthdepartments Short descriptionZuständigkeit ÖGD-Stellen Alternate namesextensions, user content Definition'ResponsibilityHealthdepartments' dient der Abbildung der Zuständigkeiten der ÖGD-Stellen anhand des amtlichen Gemeindeschlüssels und der Art der Zuständigkeit.
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.
Extension(Complex) Extension URLResponsibilityHealthdepartments 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 |
| organizationPeriod | S C | 0..1 | Extension(Period) | Element idOrganization.extension:organizationPeriod Short descriptionZeitraum der Gültigkeit Alternate namesextensions, user content DefinitionZeitraum der Gültigkeit der Organisation
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.
Extension(Period) Extension URLperiod 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 |
| modifierExtension | ?! C | 0..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).
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| identifier | S Σ C | 1..* | Identifier | Element idOrganization.identifier Short descriptionLogischer Identifier DefinitionLogischer Identifier der Organisation
Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Identifier SlicingUnordered, Open, by $this(Pattern) slicing organization identifier by pattern ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- w5: FiveWs.identifier
- v2: XON.10 / XON.3
- rim: .scopes[Role](classCode=IDENT)
- servd: ./Identifiers
|
| codeSiteId | S Σ C | 1..1 | IdentifierCodeSiteIdPattern | Element idOrganization.identifier:codeSiteId Short descriptionAn identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
IdentifierCodeSiteId ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern{
"system": "https://emiga.rki.de/fhir/vzd/sid/CodeSiteId"
}Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- w5: FiveWs.identifier
- v2: XON.10 / XON.3
- rim: .scopes[Role](classCode=IDENT)
- servd: ./Identifiers
|
| telematikID | S Σ C | 0..1 | IdentifierTelematikIdPattern | Element idOrganization.identifier:telematikID Short descriptionAn identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
Anschluß GA in TI s.gematik.de/sektoren/oegd
IdentifierTelematikId ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern{
"system": "https://gematik.de/fhir/sid/telematik-id"
}Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- w5: FiveWs.identifier
- v2: XON.10 / XON.3
- rim: .scopes[Role](classCode=IDENT)
- servd: ./Identifiers
|
| EmigaID | S Σ C | 0..1 | IdentifierEmigaIDPattern | Element idOrganization.identifier:EmigaID Short descriptionAn identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
IdentifierEmigaID ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern{
"system": "https://emiga.rki.de/fhir/sid/EmigaID"
}Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- w5: FiveWs.identifier
- v2: XON.10 / XON.3
- rim: .scopes[Role](classCode=IDENT)
- servd: ./Identifiers
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:EmigaID.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.identifier:EmigaID.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| use | S Σ ?! | 0..1 | codeBindingFixed Value | Element idOrganization.identifier:EmigaID.use Short descriptionusual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
code BindingIdentifies the purpose for this identifier, if known . IdentifierUse (required) 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())
Fixed valueofficial Mappings- rim: n/a
- v2: N/A
- rim: Role.code or implied by context
|
| type | S Σ | 0..1 | CodeableConceptBindingPattern | There are no (further) constraints on this element Element idOrganization.identifier:EmigaID.type Short descriptionArt des Identifiers DefinitionArt des Identifiers, z.B. 'MR' für Medical Record Number oder 'XX' für Organization Identifier.
Allows users to make use of identifiers when the identifier system is not known.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
CodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) 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())
Pattern{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "XX",
"display": "Organization identifier"
}
]
}Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: CX.5
- rim: Role.code or implied by context
|
| system | S Σ | 1..1 | uriPattern | There are no (further) constraints on this element Element idOrganization.identifier:EmigaID.system Short descriptionNaming-System des Identifiers DefinitionDas System, in dem der Identifier vergeben wurde.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Identifier.system is always case sensitive.
uri 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())
Patternhttps://emiga.rki.de/fhir/sid/EmigaID Examples
Generalhttp://www.acme.com/identifiers/patient Mappings- rim: n/a
- v2: CX.4 / EI-2-4
- rim: II.root or Role.id.root
- servd: ./IdentifierType
|
| value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:EmigaID.value Short descriptionWert des Identifiers DefinitionDer eigentliche Wert des Identifiers.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
string 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())
Examples
General123456 Mappings- rim: n/a
- v2: CX.1 / EI.1
- rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd: ./Value
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:EmigaID.period Short descriptionTime period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period 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()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: CX.7 + CX.8
- rim: Role.effectiveTime or implied by context
- servd: ./StartDate and ./EndDate
|
| assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.identifier:EmigaID.assigner Short descriptionOrganization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Reference(Organization) 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()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: CX.4 / (CX.4,CX.9,CX.10)
- rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd: ./IdentifierIssuingAuthority
|
| EmigaFileNumber | S Σ C | 0..1 | IdentifierEmigaFileNumberPattern | Element idOrganization.identifier:EmigaFileNumber Short descriptionAn identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
IdentifierEmigaFileNumber ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern{
"system": "https://emiga.rki.de/fhir/sid/EmigaFileNumber"
}Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- w5: FiveWs.identifier
- v2: XON.10 / XON.3
- rim: .scopes[Role](classCode=IDENT)
- servd: ./Identifiers
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:EmigaFileNumber.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.identifier:EmigaFileNumber.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| use | S Σ ?! | 0..1 | codeBindingFixed Value | Element idOrganization.identifier:EmigaFileNumber.use Short descriptionusual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
code BindingIdentifies the purpose for this identifier, if known . IdentifierUse (required) 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())
Fixed valueofficial Mappings- rim: n/a
- v2: N/A
- rim: Role.code or implied by context
|
| type | S Σ | 0..1 | CodeableConceptBindingPattern | There are no (further) constraints on this element Element idOrganization.identifier:EmigaFileNumber.type Short descriptionArt des Identifiers DefinitionArt des Identifiers, z.B. 'XX' für einen Organization Identifier.
Allows users to make use of identifiers when the identifier system is not known.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
CodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) 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())
Pattern{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "XX",
"display": "Organization identifier"
}
]
}Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: CX.5
- rim: Role.code or implied by context
|
| system | S Σ | 1..1 | uriPattern | There are no (further) constraints on this element Element idOrganization.identifier:EmigaFileNumber.system Short descriptionNaming-System des Identifiers DefinitionDas System, in dem der Identifier vergeben wurde.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Identifier.system is always case sensitive.
uri 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())
Patternhttps://emiga.rki.de/fhir/sid/EmigaFileNumber Examples
Generalhttp://www.acme.com/identifiers/patient Mappings- rim: n/a
- v2: CX.4 / EI-2-4
- rim: II.root or Role.id.root
- servd: ./IdentifierType
|
| value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idOrganization.identifier:EmigaFileNumber.value Short descriptionWert des Identifiers DefinitionDer eigentliche Wert des Identifiers. Das EMIGA Aktenzeichen wird wie folgt generiert: [ENTITÄT][CODE-SITE-ID][JAHR]-[Achtstellige-Zahl]
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
string 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())
Examples
General123456 Mappings- rim: n/a
- v2: CX.1 / EI.1
- rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd: ./Value
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.identifier:EmigaFileNumber.period Short descriptionTime period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period 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()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: CX.7 + CX.8
- rim: Role.effectiveTime or implied by context
- servd: ./StartDate and ./EndDate
|
| assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idOrganization.identifier:EmigaFileNumber.assigner Short descriptionOrganization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Reference(Organization) 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()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: CX.4 / (CX.4,CX.9,CX.10)
- rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd: ./IdentifierIssuingAuthority
|
| active | S Σ ?! | 1..1 | boolean | Element idOrganization.active Short descriptionWhether 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.
Der entsprechende Eintrag muss gepflegt werden, um eindeutig feststellen zu können, ob ein Eintrag noch aktiv ist.
This resource is generally assumed to be active if no value is provided for the active element
boolean 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())
Mappings- rim: n/a
- 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 | S Σ | 1..* | CodeableConcept | Element idOrganization.type Short descriptionKind 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.
CodeableConcept SlicingUnordered, Open, by $this(Pattern) slicing organization type by pattern BindingUsed to categorize the organization. OrganizationType (example) 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())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5: FiveWs.class
- v2: No equivalent in v2
- rim: .code
- servd: n/a
|
| emigaOrganizationType | S Σ | 0..1 | CodeableConceptBindingPattern | Element idOrganization.type:emigaOrganizationType Short descriptionKind 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.
CodeableConcept BindingUsed to categorize the organization. PublicHealthOrganizationType (required) 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())
Pattern{
"coding": [
{
"system": "https://emiga.rki.de/fhir/vzd/CodeSystem/OrganizationType"
}
]
}Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- 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:emigaOrganizationType.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.type:emigaOrganizationType.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| coding | S Σ | 1..1 | CodingPattern | There are no (further) constraints on this element Element idOrganization.type:emigaOrganizationType.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
Allows for alternative encodings within a code system, and translations to other code systems.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Coding 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())
Pattern{
"system": "https://emiga.rki.de/fhir/vzd/CodeSystem/OrganizationType"
}Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- 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:emigaOrganizationType.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.type:emigaOrganizationType.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| system | S Σ | 1..1 | uriPattern | There are no (further) constraints on this element Element idOrganization.type:emigaOrganizationType.coding.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Need to be unambiguous about the source of the definition of the symbol.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
uri 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())
Patternhttps://emiga.rki.de/fhir/vzd/CodeSystem/OrganizationType Mappings- rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
| version | S Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.type:emigaOrganizationType.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.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
string 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())
Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idOrganization.type:emigaOrganizationType.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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code 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())
Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | S Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization.type:emigaOrganizationType.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.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
string 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())
Mappings- rim: n/a
- 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:emigaOrganizationType.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).
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
boolean 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())
Mappings- rim: n/a
- 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:emigaOrganizationType.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.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Very often the text is the same as a displayName of one of the codings.
string 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())
Mappings- rim: n/a
- 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 | S Σ C | 1..1 | string | Element idOrganization.name Short descriptionName DefinitionRequirementsNeed 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.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$')
Mappings- rim: n/a
- v2: XON.1
- rim: .name
- servd: .PreferredName/Name
|
| alias | S C | 0..* | string | 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.
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.
Hinweis: Hier können Kürzel genutzt werden. Ein System muss den Alias einer Organisation zum Abruf bereitstellen, sofern diese Information verfügbar ist.
string 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()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$')
Mappings |
| telecom | S C | 0..* | ContactPoint | Element idOrganization.telecom Short descriptionA contact detail for the organization DefinitionKontaktangaben der Organisation. Telefonnummern, E-Mailadressen, Urls und Faxnummern können angegeben werden.
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.
ContactPoint SlicingUnordered, Closed, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-3 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists() - org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- 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.
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.
ContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-3 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists() - org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- 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.
string 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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| system | S Σ 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.
Note that FHIR strings SHALL NOT exceed 1MB in size
code BindingTelecommunications form for contact point. ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Fixed valueemail Mappings- rim: n/a
- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
| value | S Σ C | 1..1 | string | 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).
Need to support legacy numbers that are not in a tightly controlled format.
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
string 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()) - validEmailAddress: Die E-Mail-Adresse muss valide sein.
$this.matches('^[a-zA-Z0-9._%+-]+@(?:[a-zA-Z0-9-]+[.])+[a-zA-Z0-9]{2,63}$')
Mappings- rim: n/a
- 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.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
code BindingUse of contact point. ContactPointUse (required) 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())
Mappings- rim: n/a
- 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.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
positiveInt 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())
Mappings |
| period | Σ C | 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.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period 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()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- 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.
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.
ContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-3 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists() - org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element 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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| system | S Σ 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.
Note that FHIR strings SHALL NOT exceed 1MB in size
code BindingTelecommunications form for contact point. ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Fixed valuephone Mappings- rim: n/a
- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
| value | S Σ C | 1..1 | string | 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).
Need to support legacy numbers that are not in a tightly controlled format.
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
string 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()) - validPhoneNumber: Die Telefonnummer muss valide sein.
$this.matches('^(( ?\\+[0-9]{2,4}( ?[0-9]+? ?| ? \\([0-9]+?\\) ?))|(\\(0[0-9 ]+?\\) ?)|( 0[0-9]+? ?( |-|\/) ?))? ?[0-9]+?[0-9 \/-]*[0-9]$')
Mappings- rim: n/a
- 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.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
code BindingUse of contact point. ContactPointUse (required) 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())
Mappings- rim: n/a
- 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.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
positiveInt 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())
Mappings |
| period | Σ C | 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.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period 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()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| Url | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecom:Url Short descriptionA 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.
ContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-3 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists() - org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: ORC-22?
- rim: .telecom
- servd: ./ContactPoints
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.telecom:Url.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.telecom:Url.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| system | S Σ C | 1..1 | codeBindingFixed Value | Element idOrganization.telecom:Url.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.
Note that FHIR strings SHALL NOT exceed 1MB in size
code BindingTelecommunications form for contact point. ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Fixed valueurl Mappings- rim: n/a
- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
| value | S Σ C | 1..1 | string | Element idOrganization.telecom:Url.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).
Need to support legacy numbers that are not in a tightly controlled format.
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
string 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()) - validUrl: Die Url muss valide sein.
$this.matches('^(https?://)?[a-zA-Z0-9]+([\\.-][a-zA-Z0-9]+)*\\.[a-zA-Z]{2,6}(/[a-zA-Z0-9._~-]*)*/?$')
Mappings- rim: n/a
- 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:Url.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
code BindingUse of contact point. ContactPointUse (required) 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())
Mappings- rim: n/a
- 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:Url.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.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
positiveInt 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())
Mappings |
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.telecom:Url.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period 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()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| Fax | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization.telecom:Fax Short descriptionA 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.
ContactPoint ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-3 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists() - org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: ORC-22?
- rim: .telecom
- servd: ./ContactPoints
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.telecom:Fax.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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idOrganization.telecom:Fax.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| system | S Σ C | 1..1 | codeBindingFixed Value | Element idOrganization.telecom:Fax.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.
Note that FHIR strings SHALL NOT exceed 1MB in size
code BindingTelecommunications form for contact point. ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Fixed valuefax Mappings- rim: n/a
- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
| value | S Σ C | 1..1 | string | Element idOrganization.telecom:Fax.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).
Need to support legacy numbers that are not in a tightly controlled format.
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
string 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()) - validFaxNumber: Die Faxnummer muss valide sein.
$this.matches('^(( ?\\+[0-9]{2,4}( ?[0-9]+? ?| ? \\([0-9]+?\\) ?))|(\\(0[0-9 ]+?\\) ?)|( 0[0-9]+? ?( |-|\/) ?))? ?[0-9]+?[0-9 \/-]*[0-9]$')
Mappings- rim: n/a
- 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:Fax.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
code BindingUse of contact point. ContactPointUse (required) 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())
Mappings- rim: n/a
- 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:Fax.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.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
positiveInt 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())
Mappings |
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idOrganization.telecom:Fax.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period 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()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| address | S C | 0..* | AddressDeBasis | Element idOrganization.address Short descriptionEine Adresse gemäß postalischer Konventionen DefinitionEine Adresse gemäß postalischer Konventionen (im Gegensatz zu bspw. GPS-Koordinaten). Die Adresse kann sowohl zur Zustellung von Postsendungen oder zum Aufsuchen von Orten, die keine gültige Postadresse haben, verwendet werden.
Die verwendeten Extensions in diesem Profil bilden die Struktur der Adresse ab, wie sie im VSDM-Format der elektronischen Versichertenkarte verwendet wird.
Insbesondere bei ausländischen Adresse oder Adressen, die nicht durch Einlesen einer elektronischen Versichertenkarte erfasst wurden, sind abweichende Strukturen möglich. Die Verwendung der Extensions ist nicht verpflichtend.
May need to keep track of the organization's addresses 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).
AddressDeBasis ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, org-2 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 all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))
Examples
Beispiel für einfache Adresse{
"use": "home",
"type": "postal",
"line": [
"Musterweg 42"
],
"city": "Musterhausen",
"postalCode": "99999"
}Mappings- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
- v2: ORC-23?
- rim: .address
- servd: ./PrimaryAddress and ./OtherAddresses
|
| 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.
string 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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| Stadtteil | S C | 0..1 | Extension(string) | Element idOrganization.address.extension:Stadtteil Short descriptionStadt- oder Ortsteil Alternate namesextensions, user content DefinitionA subsection of a municipality.
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.
Extension(string) Extension URLADXP-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: N/A
- rim: ADXP[partType=PRE]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.extension:Stadtteil.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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.address.extension:Stadtteil.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.address.extension:Stadtteil.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct Mappings |
| value[x] | S C | 1..1 | | Element idOrganization.address.extension:Stadtteil.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The 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()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$')
Mappings |
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| 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.
Allows an appropriate address to be chosen from a list of many.
Applications can assume that an address is current unless it explicitly says that it is temporary or old.
code BindingThe use of an address. AddressUse (required) 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())
Examples
Generalhome Mappings- rim: n/a
- 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.
The 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).
code BindingThe type of an address (physical / postal). AddressType (required) 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())
Examples
Generalboth Mappings- rim: n/a
- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
|
| 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.
A renderable, unencoded form.
Can 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.
string 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())
Examples
General137 Nowhere Street, Erewhon 9132 Mappings- rim: n/a
- v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim: ./formatted
- vcard: address label parameter
|
| line | Σ | 0..3 | 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.
Note that FHIR strings SHALL NOT exceed 1MB in size
string 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())
Examples
General137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und HausnummerMusterweg 42 Mappings- rim: n/a
- 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)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.line.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.
string Mappings |
| 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 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| Strasse | S C | 0..1 | Extension(string) | 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.
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.
Extension(string) Extension URLADXP-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: n/a
- rim: N/A
- rim: ADXP[partType=STR]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.line.extension:Strasse.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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.address.line.extension:Strasse.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.address.line.extension:Strasse.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Mappings |
| value[x] | S C | 1..1 | | Element idOrganization.address.line.extension:Strasse.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The 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()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$')
Mappings |
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| Hausnummer | S C | 0..1 | Extension(string) | 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.
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.
Extension(string) Extension URLADXP-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: n/a
- rim: N/A
- rim: ADXP[partType=BNR]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.line.extension:Hausnummer.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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.address.line.extension:Hausnummer.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.address.line.extension:Hausnummer.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Mappings |
| value[x] | S C | 1..1 | | Element idOrganization.address.line.extension:Hausnummer.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The 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()) - validHouseNumber: Die Hausnummer muss valide sein. Zeichenlänge maximal 50 Zeichen
$this.matches('^.{1,50}$')
Mappings |
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| Adresszusatz | S C | 0..1 | Extension(string) | 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.
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.
Extension(string) Extension URLADXP-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: n/a
- rim: N/A
- rim: ADXP[partType=ADL]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.line.extension:Adresszusatz.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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.address.line.extension:Adresszusatz.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.address.line.extension:Adresszusatz.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Mappings |
| value[x] | S C | 1..1 | | Element idOrganization.address.line.extension:Adresszusatz.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The 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()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$')
Mappings |
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| Postfach | S C | 0..1 | 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.
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.
Extension(string) Extension URLADXP-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: n/a
- rim: N/A
- rim: ADXP[partType=POB]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idOrganization.address.line.extension:Postfach.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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idOrganization.address.line.extension:Postfach.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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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 |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idOrganization.address.line.extension:Postfach.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Mappings |
| value[x] | S C | 1..1 | | Element idOrganization.address.line.extension:Postfach.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The 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()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$')
Mappings |
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idOrganization.address.line.value Short descriptionPrimitive value for string DefinitionPrimitive value for string
System.String Maximum string length1048576 |
| city | S Σ C | 0..1 | string | 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.
Note that FHIR strings SHALL NOT exceed 1MB in size
string 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()) - validString: Zeichenlänge maximal 255 Zeichen
$this.matches('^.{1,255}$')
Examples
GeneralErewhon Mappings- rim: n/a
- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
|
| 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).
District 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.
string 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())
Examples
GeneralMadison Mappings- rim: n/a
- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
| state | S Σ | 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.
Note that FHIR strings SHALL NOT exceed 1MB in size
string BindingValueSetISO31662DE (preferred) 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())
Mappings- rim: n/a
- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
| postalCode | S Σ C | 0..1 | string | Element idOrganization.address.postalCode Short descriptionPostleitzahl Alternate namesZip DefinitionPostleitzahl gemäß der im jeweiligen Land gültigen Konventionen
Note that FHIR strings SHALL NOT exceed 1MB in size
string 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()) - validPLZ: Die PLZ muss valide sein. Zeichenlänge maximal 10 Zeichen
$this.matches('^.{1,10}$')
Examples
General9132 Mappings- rim: n/a
- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
|
| country | Σ | 0..1 | stringBinding | There are no (further) constraints on this element 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
ISO 3166 3 letter codes can be used in place of a human readable country name.
string BindingIso3166-1-2 (preferred) 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())
Mappings- rim: n/a
- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
|
| period | Σ C | 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.
Allows addresses to be placed in historical context.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period 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()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Examples
General{
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| partOf | S Σ C | 0..1 | Reference(Organization) | Element idOrganization.partOf Short descriptionThe 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.
Über dieses Element ist eine Hierarchiebildung möglich.
Reference(Organization) 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()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: No equivalent in HL7 v2
- rim: .playedBy[classCode=Part].scoper
- servd: n/a
|
| contact | | 0..0 | BackboneElement | Element idOrganization.contact Short descriptionContact 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.
Wir verbieten 'contact' erstmal, bis wir es später für weitere Organisationstypen und eine weiterführende Kompatibilität ggf. benötigen
BackboneElement 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())
Mappings- rim: n/a
- rim: .contactParty
|
| endpoint | C | 0..0 | Reference(Endpoint) | Element idOrganization.endpoint Short descriptionTechnical 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.
Wird für die EMIGA Anwendungsfälle derzeit nicht benötigt. Sobald wir technische Endpoints abbilden, müssen wir hier bestimmt eine weitere Profilierung vornehmen
Reference(Endpoint) 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()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
|