updatePatient
Zweck
Aktualisierung eines vorhandenen Datensatzes von personenidentifizierenden Informationen eines vorhandenen Patienten unter Angabe eines vormals vergebenen Master Person Index (MPI ID).
Voraussetzung
Die angegebenen Parameter zur Spezifikation der Matching-Domäne, der Datenquelle und der MPI-ID müssen im E-PIX vorhanden sein.
Aufruf und Rückgabe
Die bereitgestellte Funktionalität kann per POST-Request aufgerufen werden. Die erforderlichen Angaben werden per POST-BODY in Form von FHIR Parameters übermittelt.
<HOST>:<PORT>/ttp-fhir/fhir/epix/$updatePatient
Der Funktionsaufruf liefert eine Parameters-Ressource zurück.
Invocations
URL: [base]/$updatePatient
This operation changes content
Parameters (In)
| Name | Cardinality | Type | Documentation |
| domain | 1..1 | string | Angabe der Matchingdomain |
| source | 1..1 | string | Datenquelle |
| mpiIdentifier | 1..1 | Identifier | Identifikator des MPI-Eintrags (MPI-ID) |
| identity | 1..1 | Patient | Patient-Ressource (analog zu der Patienten-Identität) |
| force | 1..1 | boolean |
Return Values (Out)
| Name | Cardinality | Type | Binding | Documentation |
| matchStatus | 1..1 | Coding | MatchStatus (required) | Match-Status aus dem Matching der übermittelten Patienten-Identität |
| mpiPerson | 0..1 | Person | Person-Ressource, die den MPI-Eintrag repräsentiert. | |
| identity | 0..* | Patient | Patient-Ressource (analog zu Patienten-Identität, referenziert aus dem MPI-Index der Personen-Ressource). |
Aktualisiert Patienten-Identitäten eines MPI-Eintrags.
Der Parameter "identity" enthält eine Patient-Ressource entsprechend dem allgemeinen Patient-Profil:
| Patient | I | Patient | Element IdPatient Patienten-Profil zur Übermittlung von angeforderten IDAT Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services. Die per $requestTasks vorgegebenen Element-Bezeichner sind wie folgt gemappt: given: name.given family: name.family (mit name.use!='maiden' oder nicht vorhanden) prefix: name.prefix suffix: name.suffix birthdate: birthDate gender: gender address-line: address.line address-city: address.city address-postalcode: address.postalCode birthplace: extension('http://hl7.org/fhir/StructureDefinition/patient-birthPlace').city maidenname: name.family (mit name.use='maiden') degree: name.prefix (ggf. mit gesetzter Extension http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier mit Code 'AC') language: communication.language (mit communication.preferred=true) nationality: extension(http://hl7.org/fhir/StructureDefinition/patient-nationality).valueCode.coding.code oder extension(http://hl7.org/fhir/StructureDefinition/patient-nationality).valueCode.textextension(http://hl7.org/fhir/StructureDefinition/patient-nationality).code.text maritalstatus: maritalStatus.coding.code oder maritalStatus.text
| |
| meta | S Σ | 0..1 | Meta | There are no (further) constraints on this element Element IdPatient.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| versionId | S Σ | 0..1 | id | There are no (further) constraints on this element Element IdPatient.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
| lastUpdated | S Σ | 0..1 | instant | There are no (further) constraints on this element Element IdPatient.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
| source | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPatient.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
| profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdPatient.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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
|
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdPatient.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPatient.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
| birthPlace | S I | 0..1 | Extension(Address) | Element IdPatient.extension:birthPlace Place of Birth for patient Alternate namesextensions, user content DefinitionThe registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements. 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. http://hl7.org/fhir/StructureDefinition/patient-birthPlace Constraints
|
| url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-birthPlace
| |
| value[x] | S | 1..1 | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
| valueAddress | Address | There are no (further) constraints on this element Data Type | ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
| type | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
| line | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
| city | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
| district | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
| state | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
| postalCode | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
| country | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
| period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element IdPatient.extension:birthPlace.value[x].period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
|
| nationality | S I | 0..1 | Extension(Complex) | Element IdPatient.extension:nationality Nationality Alternate namesextensions, user content DefinitionThe nationality of the patient. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-nationality Constraints
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
| code | I | 0..1 | Extension | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:code Nationality Code Alternate namesextensions, user content DefinitionCode representing nationality of patient. 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.
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:code.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. code
| |
| value[x] | S | 1..1 | Binding | Element IdPatient.extension:nationality.extension:code.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
|
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
| coding | S Σ | 0..1 | Coding | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:code.value[x].coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:code.value[x].coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:code.value[x].coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:code.value[x].coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:code.value[x].coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:code.value[x].coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:code.value[x].text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| period | I | 0..1 | Extension | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:period Nationality Period Alternate namesextensions, user content DefinitionPeriod when nationality was effective. 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.
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:period.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. period
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element IdPatient.extension:nationality.extension:period.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
| url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdPatient.extension:nationality.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-nationality
| |
| value[x] | 0..0 | There are no (further) constraints on this element Element IdPatient.extension:nationality.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| customIdatValues | S I | 0..1 | Extension(Complex) | Element IdPatient.extension:customIdatValues Benutzerdefinierter Satz von IDAT Werten Alternate namesextensions, user content DefinitionBenutzerdefinierter Satz von von IDAT-Wert für flexible Erweiterung E-PIX IDAT-Datensatz There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttps://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues Constraints
|
| identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdPatient.identifier An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers.
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPatient.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPatient.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPatient.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPatient.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| active | S Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element IdPatient.active Whether this patient's record is in active use DefinitionWhether 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.
|
| name | S Σ | 0..* | HumanName | There are no (further) constraints on this element Element IdPatient.name A name associated with the patient DefinitionA 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.
|
| use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name. NameUse (required)Constraints
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.name.text Text representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. 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 a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
|
| family | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
| given | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPatient.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
|
| prefix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPatient.name.prefix Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPatient.name.prefix.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
| academic | S I | 0..1 | Extension(code) | Element IdPatient.name.prefix.extension:academic LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionA set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Used to indicate additional information about the name part and how it should be used. http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints
|
| url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdPatient.name.prefix.extension:academic.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
| |
| value[x] | S | 1..1 | BindingFixed Value | Element IdPatient.name.prefix.extension:academic.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required)Constraints
AC
|
| valueCode | code | There are no (further) constraints on this element Data Type | ||
| suffix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPatient.name.suffix Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element IdPatient.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| telecom | Σ I | 0..0 | ContactPoint | There are no (further) constraints on this element Element IdPatient.telecom A contact detail for the individual DefinitionA 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).
|
| gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.gender male | female | other | unknown DefinitionAdministrative 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. The gender of a person used for administrative purposes. AdministrativeGender (required)Constraints
|
| birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element IdPatient.birthDate The date of birth for the individual DefinitionThe 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).
|
| deceased[x] | Σ ?! | 0..0 | There are no (further) constraints on this element Element IdPatient.deceased[x] Indicates if the individual is deceased or not DefinitionIndicates 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.
| |
| address | S Σ | 0..* | Address | There are no (further) constraints on this element Element IdPatient.address An address for the individual DefinitionAn 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.
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPatient.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
| line | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPatient.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
| city | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
| district | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPatient.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
| state | S Σ | 0..1 | stringBinding | Element IdPatient.address.state Bundesland Alternate namesProvince, Territory DefinitionBundesland in ISO-Codierung Note that FHIR strings SHALL NOT exceed 1MB in size http://fhir.de/ValueSet/iso/bundeslaender (required) Constraints
|
| postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
| country | S Σ | 0..1 | stringBinding | Element IdPatient.address.country Staat DefinitionStaat in ISO-Codierung (zweistellig nach ISO-3166-2) ISO 3166 3 letter codes can be used in place of a human readable country name.
|
| period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element IdPatient.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
|
| maritalStatus | S | 0..1 | CodeableConceptBinding | Element IdPatient.maritalStatus Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The domestic partnership status of a person. Marital Status Codes (required)Constraints
|
| coding | S Σ | 0..1 | Coding | There are no (further) constraints on this element Element IdPatient.maritalStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPatient.maritalStatus.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.maritalStatus.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element IdPatient.maritalStatus.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.maritalStatus.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPatient.maritalStatus.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPatient.maritalStatus.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| multipleBirth[x] | 0..0 | There are no (further) constraints on this element Element IdPatient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates 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).
| ||
| photo | I | 0..0 | Attachment | There are no (further) constraints on this element Element IdPatient.photo Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Guidelines:
|
| contact | I | 0..0 | BackboneElement | There are no (further) constraints on this element Element IdPatient.contact A contact party (e.g. guardian, partner, friend) for the patient DefinitionA 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.
|
| communication | S | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPatient.communication A language which may be used to communicate with the patient about his or her health DefinitionA 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.
|
| language | S | 1..1 | CodeableConceptBinding | Element IdPatient.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe 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. A human language. CommonLanguages (required)Constraints
|
| coding | S Σ | 0..1 | Coding | There are no (further) constraints on this element Element IdPatient.communication.language.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPatient.communication.language.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.communication.language.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element IdPatient.communication.language.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.communication.language.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPatient.communication.language.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPatient.communication.language.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| preferred | S | 1..1 | booleanFixed Value | Element IdPatient.communication.preferred Language preference indicator DefinitionIndicates 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.
true
|
| generalPractitioner | I | 0..0 | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdPatient.generalPractitioner Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient'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
|
| managingOrganization | Σ I | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element IdPatient.managingOrganization Organization that is the custodian of the patient record DefinitionOrganization 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).
|
| link | Σ ?! | 0..0 | BackboneElement | There are no (further) constraints on this element Element IdPatient.link Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple use cases:
There is no assumption that linked patient records have mutual links.
|
Der Parameter "mpiPerson" enthält eine Person-Ressource entsprechend dem allgemeinen Person-Profil. Die Angabe link.assurance='level4' kennzeichnet hierbei die Referenz-Identität:
| Person | I | Person | There are no (further) constraints on this element Element IdPerson A generic person record DefinitionDemographics and administrative information about a person independent of a specific health-related context. The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).
| |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element IdPerson.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdPerson.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
| lastUpdated | S Σ | 0..1 | instant | There are no (further) constraints on this element Element IdPerson.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPerson.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
| profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdPerson.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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
|
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdPerson.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdPerson.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPerson.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
| customIdatValues | S I | 0..* | Extension(Complex) | Element IdPerson.extension:customIdatValues Custom IDAT Values Alternate namesextensions, user content DefinitionCustom IDAT Values There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttps://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues Constraints
|
| identifier | S | 1..* | Identifier | There are no (further) constraints on this element Element IdPerson.identifier A human identifier for this person DefinitionIdentifier for a person within a particular scope. People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPerson.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPerson.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdPerson.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPerson.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPerson.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPerson.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| name | S Σ | 0..* | HumanName | There are no (further) constraints on this element Element IdPerson.name A name associated with the person DefinitionA name associated with the person. Need to be able to track the person by multiple names. Examples are your official name and a partner name. Person may have multiple names with different uses or applicable periods.
|
| use | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPerson.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name. NameUse (required)Constraints
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPerson.name.text Text representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. 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 a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
|
| family | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPerson.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
| given | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPerson.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
|
| prefix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPerson.name.prefix Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdPerson.name.prefix.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
| academic | I | 0..* | Extension(code) | Element IdPerson.name.prefix.extension:academic LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionA set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Used to indicate additional information about the name part and how it should be used. http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints
|
| url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdPerson.name.prefix.extension:academic.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
| |
| value[x] | S | 1..1 | BindingFixed Value | Element IdPerson.name.prefix.extension:academic.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required)Constraints
AC
|
| valueCode | code | There are no (further) constraints on this element Data Type | ||
| suffix | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPerson.name.suffix Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPerson.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| telecom | Σ I | 0..0 | ContactPoint | There are no (further) constraints on this element Element IdPerson.telecom A contact detail for the person DefinitionA 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. Person 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.
|
| gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPerson.gender male | female | other | unknown DefinitionAdministrative Gender. Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes. 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 M and F, though a clear majority of systems and contexts only support M and F. The gender of a person used for administrative purposes. AdministrativeGender (required)Constraints
|
| birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element IdPerson.birthDate The date on which the person was born DefinitionThe birth date for the person. Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues. At least an estimated year should be provided as a guess if the real DOB is unknown.
|
| address | S | 0..* | Address | There are no (further) constraints on this element Element IdPerson.address One or more addresses for the person DefinitionOne or more addresses for the person. May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification. Person may have multiple addresses with different uses or applicable periods.
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPerson.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address. AddressUse (required)Constraints
General home Mappings
|
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPerson.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The type of an address (physical / postal). AddressType (required)Constraints
General both Mappings
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPerson.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
| line | S Σ | 0..* | string | There are no (further) constraints on this element Element IdPerson.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
| city | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPerson.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
| district | Σ | 0..0 | string | There are no (further) constraints on this element Element IdPerson.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
| state | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPerson.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
| postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPerson.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
| country | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdPerson.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
| period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element IdPerson.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
|
| photo | I | 0..0 | Attachment | There are no (further) constraints on this element Element IdPerson.photo Image of the person DefinitionAn image that can be displayed as a thumbnail of the person to enhance the identification of the individual. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
| managingOrganization | S Σ I | 1..1 | Reference(Organization) | Element IdPerson.managingOrganization Domäne Definitionrepräsentiert hier die Domäne, zur der der MPI-Eintrag gehört. Need to know who recognizes this person record, manages and updates it. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdPerson.managingOrganization.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPerson.managingOrganization.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
| identifier | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element IdPerson.managingOrganization.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPerson.managingOrganization.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdPerson.managingOrganization.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
| system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdPerson.managingOrganization.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdPerson.managingOrganization.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPerson.managingOrganization.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdPerson.managingOrganization.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPerson.managingOrganization.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
| active | S Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element IdPerson.active This person's record is in active use DefinitionWhether this person's record is in active use. Need to be able to mark a person record as not to be used because it was created in error.
|
| link | S | 1..* | BackboneElement | There are no (further) constraints on this element Element IdPerson.link Link to a resource that concerns the same actual person DefinitionLink to a resource that concerns the same actual person.
|
| target | S I | 1..1 | Reference(Patient) | Element IdPerson.link.target The resource to which this actual person is associated DefinitionThe resource to which this actual person is associated. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdPerson.link.target.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdPerson.link.target.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdPerson.link.target.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdPerson.link.target.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
| assurance | S | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPerson.link.assurance level1 | level2 | level3 | level4 DefinitionLevel of assurance that this link is associated with the target resource. Note that FHIR strings SHALL NOT exceed 1MB in size The level of confidence that this link represents the same actual person, based on NIST Authentication Levels. IdentityAssuranceLevel (required)Constraints
|
Im Erfolgsfall wird der HTTP Statuscode 200 zurückgegeben.
Im Fehlerfall wird einer der folgenden HTTP Statuscodes in Verbindung mit einer OperationOutcome-Ressource zurückgegeben:
- 400: Fehlende oder fehlerhafte Parameter.
- 401: Fehlende Authentifizierung oder Autorisierung.
- 422: Fehlende oder falsche Patienten-Attribute.
Beispiel
Beispielhafter Request-Body:
<Parameters xmlns="http://hl7.org/fhir"> <id value="Parameters-UpdatePatient-request-example-1" /> <parameter> <name value="domain" /> <valueString value="MIRACUM" /> </parameter> <parameter> <name value="source" /> <valueString value="KlinikumXY" /> </parameter> <parameter> <name value="mpiIdentifier" /> <valueIdentifier> <system value="https://ths-greifswald.de/fhir/identifier/BeispielMpiId" /> <value value="1001000000066" /> </valueIdentifier> </parameter> <parameter> <name value="identity" /> <resource> <Patient> <meta> <profile value="https://ths-greifswald.de/fhir/StructureDefinition/epix/Patient" /> </meta> <name> <family value="xxxxx" /> <given value="Stefanie" /> </name> <birthDate value="1962-12-16" /> <address> <city value="Spöck" /> <postalCode value="76297" /> </address> </Patient> </resource> </parameter> <parameter> <name value="force" /> <valueBoolean value="false" /> </parameter> </Parameters>
Beispielhafte Response:
<Parameters xmlns="http://hl7.org/fhir"> <id value="Parameters-UpdatePatient-response-example-1" /> <parameter> <name value="matchStatus" /> <valueCoding> <system value="https://ths-greifswald.de/fhir/CodeSystem/epix/MatchStatus" /> <code value="PERFECT_MATCH_WITH_UPDATE" /> </valueCoding> </parameter> <parameter> <name value="mpiPerson" /> <resource> <Person> <id value="52" /> <meta> <lastUpdated value="2021-06-17T08:28:03.200+02:00" /> <profile value="https://ths-greifswald.de/fhir/StructureDefinition/epix/Person" /> </meta> <identifier> <system value="https://ths-greifswald.de/fhir/identifier/BeispielMpiId" /> <value value="1001000000066" /> </identifier> <managingOrganization> <identifier> <value value="MIRACUM" /> </identifier> </managingOrganization> <active value="true" /> <link> <target> <reference value="Patient/52" /> </target> </link> <link> <target> <reference value="Patient/53" /> </target> <assurance value="level4" /> </link> </Person> </resource> </parameter> <parameter> <name value="identity" /> <resource> <Patient> <id value="52" /> <meta> <versionId value="1" /> <lastUpdated value="2021-06-17T08:28:03.200+02:00" /> <source value="dummy_safe_source" /> <profile value="https://ths-greifswald.de/fhir/StructureDefinition/epix/Patient" /> </meta> <active value="true" /> <name> <family value="xxxxx" /> <given value="Stefanie" /> </name> <gender value="male" /> <birthDate value="1962-12-17" /> </Patient> </resource> </parameter> <parameter> <name value="identity" /> <resource> <Patient> <id value="53" /> <meta> <versionId value="1" /> <lastUpdated value="2021-10-28T09:10:11.120+02:00" /> <source value="KlinikumXY" /> <profile value="https://ths-greifswald.de/fhir/StructureDefinition/epix/Patient" /> </meta> <active value="true" /> <name> <family value="xxxxx" /> <given value="Stefanie" /> </name> <gender value="male" /> <birthDate value="1962-12-16" /> <address> <city value="Spöck" /> <postalCode value="76297" /> </address> </Patient> </resource> </parameter> </Parameters>