| MII_PR_Person_PatientPseudonymisiert (Patient) | I | | Patient | Element idShort description Information about an individual or animal receiving health care services Alternate names SubjectOfCare Client Resident Definition Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Patient Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - mii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
- rim: Entity. Role, or Act
- rim: Patient[classCode=PAT]
- cda: ClinicalDocument.recordTarget.patientRole
|
| id | S Σ | 0..1 | string | There are no (further) constraints on this element Element idShort description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
string |
| meta | S Σ | 0..1 | Meta | There are no (further) constraints on this element Element idShort description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Meta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idShort description Version specific identifier Definition The 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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idShort description When the resource version last changed Definition When 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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idShort description Identifies where the resource comes from Definition A 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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| profile | S Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idShort description Profiles this resource claims to conform to Definition Comments It 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) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idShort description Security Labels applied to this resource Definition Security 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 Binding Security Labels from the Healthcare Privacy and Security Classification System.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idShort description Tags applied to this resource Definition Tags 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 Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idShort description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description Language of the resource content Definition The 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 Binding CommonLanguages (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| text | | 0..1 | Narrative | There are no (further) constraints on this element Element idShort description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idShort description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
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 |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 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()
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 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()
|
| identifier | S Σ | 1..* | Identifier | Element idShort description An identifier for this patient Definition An identifier for this patient.
Patients are almost always assigned specific numerical identifiers.
Identifier Sliced: Unordered, Open, by $this(Pattern) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- w5: FiveWs.identifier
- v2: PID-3
- rim: id
- cda: .id
|
| PseudonymisierterIdentifier | S Σ | 0..* | IdentifierPattern | Element idPatient.identifier:PseudonymisierterIdentifier An identifier for this patient Definition An identifier for this patient.
Patients are almost always assigned specific numerical identifiers.
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
"code": "PSEUDED"
}
]
}
}- w5: FiveWs.identifier
- v2: PID-3
- rim: id
- cda: .id
|
| AnonymisierterIdentifier | S Σ | 0..* | IdentifierPattern | Element idPatient.identifier:AnonymisierterIdentifier An identifier for this patient Definition An identifier for this patient.
Patients are almost always assigned specific numerical identifiers.
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
"code": "ANONYED"
}
]
}
}- w5: FiveWs.identifier
- v2: PID-3
- rim: id
- cda: .id
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idShort description Whether this patient's record is in active use Definition Whether this patient record is in active use.
Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.
It is often used to filter patient lists to exclude inactive patients
Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
Need to be able to mark a patient record as not to be used because it was created in error.
If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.
This resource is generally assumed to be active if no value is provided for the active element
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- w5: FiveWs.status
- rim: statusCode
- cda: n/a
|
| name | Σ | 0..* | HumanName | There are no (further) constraints on this element Element idShort description A name associated with the patient Definition A name associated with the individual.
Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.
HumanName Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-5, PID-9
- rim: name
- cda: .patient.name
|
| telecom | Σ | 0..* | ContactPoint | There are no (further) constraints on this element Element idShort description A contact detail for the individual Definition A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
People have (primary) ways to contact them in some way such as phone, email.
A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
ContactPoint Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-13, PID-14, PID-40
- rim: telecom
- cda: .telecom
|
| gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description male | female | other | unknown Definition Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
Needed for identification of the individual, in combination with (at least) name and birth date.
The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.
code Binding The gender of a person used for administrative purposes.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-8
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: .patient.administrativeGenderCode
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references)
string |
| extension | I | 0..* | Extension | Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| other-amtlich | S I | 0..1 | Extension(Coding) | Element idPatient.gender.extension:other-amtlich Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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(Coding) Extension URL http://fhir.de/StructureDefinition/gender-amtlich-de 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()
|
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idShort description Primitive value for code Definition Data type System.String |
| birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element idShort description The date of birth for the individual Definition The date of birth for the individual.
Age of the individual drives many clinical processes.
At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).
date Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-7
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
- cda: .patient.birthTime
- loinc: 21112-8
|
| deceased[x] | S Σ ?! | 0..1 | | Element idShort description Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not.
The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
Unordered, Open, by $this(Type) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-30 (bool) and PID-29 (datetime)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
- cda: n/a
|
| (All Slices) | | | | There are no (further) constraints on this element |
| deceasedBoolean | | | boolean | There are no (further) constraints on this element Data type boolean |
| deceasedDateTime | S Σ ?! | 0..1 | dateTime | Element idPatient.deceased[x]:deceasedDateTime Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not.
The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-30 (bool) and PID-29 (datetime)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
- cda: n/a
|
| address | S Σ | 0..* | Address | Element idShort description An address for the individual Definition An address for the individual.
May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
Patient may have multiple addresses with different uses or applicable periods.
Address Sliced: Unordered, Open, by $this(Pattern) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-11
- rim: addr
- cda: .addr
|
| Strassenanschrift | S Σ I | 0..* | AddressDeBasisPattern | Element idPatient.address:Strassenanschrift Eine Adresse gemäß postalischer Konventionen Definition Eine 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 patient addresses for contacting, billing or reporting requirements and also to help with identification.
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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - 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)) - pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
- v2: PID-11
- rim: addr
- cda: .addr
- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| Stadtteil | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.extension:Stadtteil Stadt- oder Ortsteil Alternate names extensions, user content Definition A 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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct 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()
- rim: n/a
- rim: ADXP[partType=PRE]
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.use home | work | temp | old | billing - purpose of this address Definition The 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 Binding AddressUse (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
|
| type | S Σ | 1..1 | codeBindingPattern | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.type postal | physical | both Definition Distinguishes 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 Binding The type of an address (physical / postal).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
- BDT: 1202 (1=physical, 2=postal)
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.text Text representation of the address Definition Specifies 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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General137 Nowhere Street, Erewhon 9132
Mappings- v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim: ./formatted
- vcard: address label parameter
|
| line | Σ | 0..3 | string | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.line Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung Definition Diese 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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General137 Nowhere Street
Beipiel für Adresszeile mit Extensions für Straße und HausnummerMusterweg 42
Mappings- v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
- rim: AD.part[parttype = AL]
- vcard: street
- servd: ./StreetAddress (newline delimitted)
- KVDT: 3107 + 3109 + 3115 oder 3123
- BDT: 3107 + 3109 + 3115 oder 3123
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.line.id xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references)
string |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.line.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| Strasse | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.line.extension:Strasse Strassenname (ohne Hausnummer) Alternate names extensions, user content Definition Strassenname (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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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()
- rim: ADXP[partType=STR]
- KVDT: 3107
- BDT: 3107
|
| Hausnummer | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.line.extension:Hausnummer Hausnummer Alternate names extensions, user content Definition Hausnummer, 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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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()
- rim: ADXP[partType=BNR]
- KVDT: 3109
- BDT: 3109
|
| Adresszusatz | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.line.extension:Adresszusatz Adresszusatz Alternate names extensions, user content Definition Zusä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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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()
- rim: ADXP[partType=ADL]
- KVDT: 3115
- BDT: 3115
|
| Postfach | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.line.extension:Postfach Postfach Alternate names extensions, user content Definition Postfach-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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox 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()
- rim: ADXP[partType=POB]
- KVDT: 3123
- BDT: 3123
|
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.line.value Primitive value for string Definition Data type System.String Maximum string length |
| city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.city Name of city, town etc. Alternate names Municpality Definition The name of the city, town, suburb, village or other community or delivery center.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
- BDT: 3113 oder 3122 (Postfach)
- KVDT: 3113 oder 3122 (Postfach)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.city.id xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references)
string |
| extension | I | 0..* | Extension | Element idPatient.address:Strassenanschrift.city.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| gemeindeschluessel | S I | 0..1 | Extension(Coding) | Element idPatient.address:Strassenanschrift.city.extension:gemeindeschluessel Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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(Coding) Extension URL http://fhir.de/StructureDefinition/destatis/ags 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()
|
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.city.value Primitive value for string Definition Data type System.String Maximum string length |
| district | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.district District name (aka county) Alternate names County Definition The 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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
| state | Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.state Bundesland Alternate names Province, Territory Definition Name (oder Kürzel) des Bundeslandes.
string Binding ValueSetISO31662DE (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
| postalCode | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.postalCode Postleitzahl Alternate names Zip Definition Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
- BDT: 3112 oder 3121 (Postfach)
- KVDT: 3112 oder 3121 (Postfach)
|
| country | S Σ | 1..1 | stringBinding | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.country Staat Definition Staat (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 Binding Iso3166-1-2 (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
- BDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
- KVDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
|
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.period Time period when address was/is in use Definition Time period when address was/is in use.
Allows addresses to be placed in historical context.
Period Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General{
"start": "2010-03-23",
"end": "2010-07-01"
}
Mappings- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.period.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.period.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.period.start Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive.
If the low element is missing, the meaning is that the low boundary is not known.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: DR.1
- rim: ./low
- BDT: 8226
|
| end | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address:Strassenanschrift.period.end End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
If the end of the period is missing, it means that the period is ongoing
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: DR.2
- rim: ./high
- BDT: 8227
|
| Postfach | S Σ I | 0..* | AddressDeBasisPattern | Element idShort description Eine Adresse gemäß postalischer Konventionen Definition Eine 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 patient addresses for contacting, billing or reporting requirements and also to help with identification.
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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - 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)) - pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
- v2: PID-11
- rim: addr
- cda: .addr
- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Postfach.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address:Postfach.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| Stadtteil | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Postfach.extension:Stadtteil Stadt- oder Ortsteil Alternate names extensions, user content Definition A 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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct 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()
- rim: n/a
- rim: ADXP[partType=PRE]
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address:Postfach.use home | work | temp | old | billing - purpose of this address Definition The 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 Binding AddressUse (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
|
| type | S Σ | 1..1 | codeBindingPattern | There are no (further) constraints on this element Element idPatient.address:Postfach.type postal | physical | both Definition Distinguishes 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 Binding The type of an address (physical / postal).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
- BDT: 1202 (1=physical, 2=postal)
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Postfach.text Text representation of the address Definition Specifies 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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General137 Nowhere Street, Erewhon 9132
Mappings- v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim: ./formatted
- vcard: address label parameter
|
| line | Σ | 0..3 | string | There are no (further) constraints on this element Element idPatient.address:Postfach.line Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung Definition Diese 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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General137 Nowhere Street
Beipiel für Adresszeile mit Extensions für Straße und HausnummerMusterweg 42
Mappings- v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
- rim: AD.part[parttype = AL]
- vcard: street
- servd: ./StreetAddress (newline delimitted)
- KVDT: 3107 + 3109 + 3115 oder 3123
- BDT: 3107 + 3109 + 3115 oder 3123
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Postfach.line.id xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references)
string |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address:Postfach.line.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| Strasse | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Postfach.line.extension:Strasse Strassenname (ohne Hausnummer) Alternate names extensions, user content Definition Strassenname (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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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()
- rim: ADXP[partType=STR]
- KVDT: 3107
- BDT: 3107
|
| Hausnummer | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Postfach.line.extension:Hausnummer Hausnummer Alternate names extensions, user content Definition Hausnummer, 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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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()
- rim: ADXP[partType=BNR]
- KVDT: 3109
- BDT: 3109
|
| Adresszusatz | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Postfach.line.extension:Adresszusatz Adresszusatz Alternate names extensions, user content Definition Zusä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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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()
- rim: ADXP[partType=ADL]
- KVDT: 3115
- BDT: 3115
|
| Postfach | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address:Postfach.line.extension:Postfach Postfach Alternate names extensions, user content Definition Postfach-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 URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox 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()
- rim: ADXP[partType=POB]
- KVDT: 3123
- BDT: 3123
|
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.address:Postfach.line.value Primitive value for string Definition Data type System.String Maximum string length |
| city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Postfach.city Name of city, town etc. Alternate names Municpality Definition The name of the city, town, suburb, village or other community or delivery center.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
- BDT: 3113 oder 3122 (Postfach)
- KVDT: 3113 oder 3122 (Postfach)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Postfach.city.id xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references)
string |
| extension | I | 0..* | Extension | Element idPatient.address:Postfach.city.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| gemeindeschluessel | S I | 0..1 | Extension(Coding) | Element idPatient.address:Postfach.city.extension:gemeindeschluessel Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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(Coding) Extension URL http://fhir.de/StructureDefinition/destatis/ags 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()
|
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.address:Postfach.city.value Primitive value for string Definition Data type System.String Maximum string length |
| district | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.address:Postfach.district District name (aka county) Alternate names County Definition The 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 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
| state | Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element idPatient.address:Postfach.state Bundesland Alternate names Province, Territory Definition Name (oder Kürzel) des Bundeslandes.
string Binding ValueSetISO31662DE (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
| postalCode | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.address:Postfach.postalCode Postleitzahl Alternate names Zip Definition Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
- BDT: 3112 oder 3121 (Postfach)
- KVDT: 3112 oder 3121 (Postfach)
|
| country | S Σ | 1..1 | stringBinding | There are no (further) constraints on this element Element idPatient.address:Postfach.country Staat Definition Staat (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 Binding Iso3166-1-2 (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
- BDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
- KVDT: 3114 oder 3124 (Postfach), abweichendes CodeSystem
|
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address:Postfach.period Time period when address was/is in use Definition Time period when address was/is in use.
Allows addresses to be placed in historical context.
Period Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General{
"start": "2010-03-23",
"end": "2010-07-01"
}
Mappings- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address:Postfach.period.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address:Postfach.period.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address:Postfach.period.start Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive.
If the low element is missing, the meaning is that the low boundary is not known.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: DR.1
- rim: ./low
- BDT: 8226
|
| end | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.address:Postfach.period.end End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
If the end of the period is missing, it means that the period is ongoing
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: DR.2
- rim: ./high
- BDT: 8227
|
| maritalStatus | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idShort description Marital (civil) status of a patient Definition This field contains a patient's most recent marital (civil) status.
Most, if not all systems capture it.
CodeableConcept Binding The domestic partnership status of a person.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-16
- rim: player[classCode=PSN]/maritalStatusCode
- cda: .patient.maritalStatusCode
|
| multipleBirth[x] | | 0..1 | | There are no (further) constraints on this element Element idShort description Whether patient is part of a multiple birth Definition Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-24 (bool), PID-25 (integer)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
- cda: n/a
|
| multipleBirthBoolean | | | boolean | There are no (further) constraints on this element Data type boolean |
| multipleBirthInteger | | | integer | There are no (further) constraints on this element Data type integer |
| photo | | 0..* | Attachment | There are no (further) constraints on this element Element idShort description Image of the patient Definition Requirements Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.
Guidelines:
- Use id photos, not clinical photos.
- Limit dimensions to thumbnail.
- Keep byte count low to ease resource updates.
Attachment Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: OBX-5 - needs a profile
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
- cda: n/a
|
| contact | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idShort description A contact party (e.g. guardian, partner, friend) for the patient Definition A contact party (e.g. guardian, partner, friend) for the patient.
Need to track people you can contact about the patient.
Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - pat-1: SHALL at least contain a contact's details or a reference to an organization
name.exists() or telecom.exists() or address.exists() or organization.exists()
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
- cda: n/a
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 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()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 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()
|
| relationship | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationship The kind of relationship Definition The nature of the relationship between the patient and the contact person.
Used to determine which contact person is the most relevant to approach, depending on circumstances.
CodeableConcept Binding The nature of the relationship between a patient and a contact person for that patient.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: NK1-7, NK1-3
- rim: code
- cda: n/a
|
| name | | 0..1 | HumanName | There are no (further) constraints on this element Element idShort description A name associated with the contact person Definition A name associated with the contact person.
Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
HumanName Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: NK1-2
- rim: name
- cda: n/a
|
| telecom | | 0..* | ContactPoint | There are no (further) constraints on this element Element idShort description A contact detail for the person Definition A contact detail for the person, e.g. a telephone number or an email address.
People have (primary) ways to contact them in some way such as phone, email.
Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.
ContactPoint Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: NK1-5, NK1-6, NK1-40
- rim: telecom
- cda: n/a
|
| address | | 0..1 | Address | There are no (further) constraints on this element Element idShort description Address for the contact person Definition Address for the contact person.
Need to keep track where the contact person can be contacted per postal mail or visited.
Address Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: NK1-4
- rim: addr
- cda: n/a
|
| gender | | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description male | female | other | unknown Definition Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
Needed to address the person correctly.
code Binding The gender of a person used for administrative purposes.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: NK1-15
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: n/a
|
| organization | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organization Organization that is associated with the contact Definition Organization on behalf of which the contact is acting or for which the contact is working.
For guardians or business related contacts, the organization is relevant.
Reference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
- rim: scoper
- cda: n/a
|
| period | | 0..1 | Period | There are no (further) constraints on this element Element idShort description The period during which this contact person or organization is valid to be contacted relating to this patient Definition The period during which this contact person or organization is valid to be contacted relating to this patient.
Period Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: effectiveTime
- cda: n/a
|
| communication | | 0..* | BackboneElement | There are no (further) constraints on this element Element idShort description A language which may be used to communicate with the patient about his or her health Definition A language which may be used to communicate with the patient about his or her health.
If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.
If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: LanguageCommunication
- cda: patient.languageCommunication
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 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()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 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()
|
| language | | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.communication.language The language which can be used to communicate with the patient about his or her health Definition The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.
Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.
The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
CodeableConcept Binding CommonLanguages (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-15, LAN-2
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
- cda: .languageCode
|
| preferred | | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferred Language preference indicator Definition Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.
This language is specifically identified for communicating healthcare information.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-15
- rim: preferenceInd
- cda: .preferenceInd
|
| generalPractitioner | | 0..* | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitioner Patient's nominated primary care provider Alternate names careProvider Definition Patient's nominated care provider.
This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.
Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.
Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.
Reference(Organization | Practitioner | PractitionerRole) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PD1-4
- rim: subjectOf.CareEvent.performer.AssignedEntity
- cda: n/a
|
| managingOrganization | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Organization that is the custodian of the patient record Definition Organization that is the custodian of the patient record.
Need to know who recognizes this patient record, manages and updates it.
There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).
Reference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: scoper
- cda: .providerOrganization
|
| link | S Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idShort description Link to another patient resource that concerns the same actual person Definition Link to another patient resource that concerns the same actual patient.
There are multiple use cases:
- Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
- Distribution of patient information across multiple servers.
There is no assumption that linked patient records have mutual links.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: outboundLink
- cda: n/a
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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 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()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 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()
|
| other | S Σ | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idShort description The other patient or related person resource that the link refers to Definition The other patient resource that the link refers to.
Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.
Reference(Patient | RelatedPerson) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- v2: PID-3, MRG-1
- rim: id
- cda: n/a
|
| type | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idShort description replaced-by | replaces | refer | seealso Definition The type of link between this patient resource and another patient resource.
code Binding The type of link between this patient resource and another patient resource.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
