SMIS Patient profile
Logical URI: http://smis.ch/fhir/StructureDefinition/Patient
Base Profile
The profile builds on Patient
Patient | I | | http://hl7.org/fhir/StructureDefinition/DomainResource | Element idShort description Information about an individual or animal receiving health care services Alternate names SubjectOfCare Client Resident Definition Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Data type http://hl7.org/fhir/StructureDefinition/DomainResource Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
Mappings- rim: Entity. Role, or Act
- rim: Patient[classCode=PAT]
- cda: ClinicalDocument.recordTarget.patientRole
- w5: administrative.individual
|
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idShort description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data type id |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idShort description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Data type Meta |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idShort description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Data type uri |
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description Language of the resource content Definition The base language in which the resource is written.
Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data type code Binding A human language. ?? (extensible) |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idShort description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Data type Narrative Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idShort description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
Data type Resource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
extension | | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional Content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments 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.
Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Comments 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.
Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idShort description An identifier for this patient Definition An identifier for this patient.
Requirements Patients are almost always assigned specific numerical identifiers.
Data type Identifier Mappings- v2: PID-3
- rim: id
- cda: .id
- w5: id
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idShort description Whether this patient's record is in active use Definition Whether this patient record is in active use.
Requirements Need to be able to mark a patient record as not to be used because it was created in error.
Comments Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient
This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.
Data type boolean Default value Mappings- rim: statusCode
- cda: n/a
- w5: status
|
name | Σ | 0..* | HumanName | There are no (further) constraints on this element Element idShort description A name associated with the patient Definition A name associated with the individual.
Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
Comments 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.
Data type HumanName Mappings- v2: PID-5, PID-9
- rim: name
- cda: .patient.name
|
telecom | Σ | 0..* | ContactPoint | There are no (further) constraints on this element Element idShort description A contact detail for the individual Definition A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
Requirements People have (primary) ways to contact them in some way such as phone, email.
Comments 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 may 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).
Data type ContactPoint Mappings- v2: PID-13, PID-14, PID-40
- rim: telecom
- cda: .telecom
|
gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description male | female | other | unknown Definition Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
Requirements Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.
Comments The gender may 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 the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, 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, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error.
Data type code Binding The gender of a person used for administrative purposes. ?? (required)Mappings- v2: PID-8
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: .patient.administrativeGenderCode
|
birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idShort description The date of birth for the individual Definition The date of birth for the individual.
Requirements Age of the individual drives many clinical processes.
Comments 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 maternaty/infant care systems).
Data type date Mappings- v2: PID-7
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
- cda: .patient.birthTime
- loinc: 21112-8
|
deceased[x] | Σ ?! | 0..1 | | There are no (further) constraints on this element Element idShort description Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not.
Requirements 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.
Comments 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.
This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
Mappings- v2: PID-30 (bool) and PID-29 (datetime)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
- cda: n/a
|
deceasedBoolean | | | boolean | There are no (further) constraints on this element Data type boolean |
deceasedDateTime | | | dateTime | There are no (further) constraints on this element Data type dateTime |
address | Σ | 0..* | Address | There are no (further) constraints on this element Element idShort description Addresses for the individual Definition Addresses for the individual.
Requirements May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
Comments Patient may have multiple addresses with different uses or applicable periods.
Data type Address Mappings- v2: PID-11
- rim: addr
- cda: .addr
|
maritalStatus | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idShort description Marital (civil) status of a patient Definition This field contains a patient's most recent marital (civil) status.
Requirements Most, if not all systems capture it.
Data type CodeableConcept Binding The domestic partnership status of a person. ?? (extensible)Mappings- v2: PID-16
- rim: player[classCode=PSN]/maritalStatusCode
- cda: .patient.maritalStatusCode
|
multipleBirth[x] | | 0..1 | | There are no (further) constraints on this element Element idShort description Whether patient is part of a multiple birth Definition Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
Comments Where the valueInteger is provided, the number is the birth number in the sequence.
E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3
If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).
Mappings- v2: PID-24 (bool), PID-25 (integer)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
- cda: n/a
|
multipleBirthBoolean | | | boolean | There are no (further) constraints on this element Data type boolean |
multipleBirthInteger | | | integer | There are no (further) constraints on this element Data type integer |
photo | | 0..* | Attachment | There are no (further) constraints on this element Element idShort description Image of the patient Definition Requirements Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.
Data type Attachment Mappings- v2: OBX-5 - needs a profile
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
- cda: n/a
|
contact | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idShort description A contact party (e.g. guardian, partner, friend) for the patient Definition A contact party (e.g. guardian, partner, friend) for the patient.
Requirements Need to track people you can contact about the patient.
Comments 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.
Data type BackboneElement Constraints- pat-1: SHALL at least contain a contact's details or a reference to an organization
name.exists() or telecom.exists() or address.exists() or organization.exists()
Mappings- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
- cda: n/a
|
animal | Σ ?! | 0..1 | BackboneElement | There are no (further) constraints on this element Element idShort description This patient is known to be an animal (non-human) Definition This patient is known to be an animal.
Requirements Many clinical systems are extended to care for animal patients as well as human.
Comments The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).
Data type BackboneElement Mappings- rim: player[classCode=ANM]
- cda: n/a
|
communication | | 0..* | BackboneElement | There are no (further) constraints on this element Element idShort description A list of Languages which may be used to communicate with the patient about his or her health Definition Languages which may be used to communicate with the patient about his or her health.
Requirements If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.
Comments 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.
Data type BackboneElement Mappings- rim: LanguageCommunication
- cda: patient.languageCommunication
|
generalPractitioner | | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Organization | http://hl7.org/fhir/StructureDefinition/Practitioner) | There are no (further) constraints on this element Element idPatient.generalPractitioner Short description Patient's nominated primary care provider Alternate names careProvider Definition Patient's nominated care provider.
Comments This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity 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.
Data type Reference(http://hl7.org/fhir/StructureDefinition/Organization | http://hl7.org/fhir/StructureDefinition/Practitioner) Mappings- v2: PD1-4
- rim: subjectOf.CareEvent.performer.AssignedEntity
- cda: n/a
|
managingOrganization | Σ | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Short description Organization that is the custodian of the patient record Definition Organization that is the custodian of the patient record.
Requirements Need to know who recognizes this patient record, manages and updates it.
Comments 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).
Data type Reference(http://hl7.org/fhir/StructureDefinition/Organization) Mappings- rim: scoper
- cda: .providerOrganization
|
link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idShort description Link to another patient resource that concerns the same actual person Definition Link to another patient resource that concerns the same actual patient.
Requirements There are multiple usecases:
- Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.
Comments There is no assumption that linked patient records have mutual links.
This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.
Data type BackboneElement Mappings- rim: outboundLink
- cda: n/a
|
Differential table
Patient | | | http://hl7.org/fhir/StructureDefinition/Patient | There are no (further) constraints on this element Data type http://hl7.org/fhir/StructureDefinition/Patient |
name | | 1.. | | There are no (further) constraints on this element Element id |
family | | 1.. | | There are no (further) constraints on this element Element id |
given | | 1..1 | | There are no (further) constraints on this element Element id |
gender | | 1.. | | There are no (further) constraints on this element Element id |
birthDate | | 1.. | | There are no (further) constraints on this element Element id |
address | | 1.. | | There are no (further) constraints on this element Element id |
city | | 1.. | | There are no (further) constraints on this element Element id |
postalCode | | 1.. | | There are no (further) constraints on this element Element idPatient.address.postalCode |
animal | | ..0 | | There are no (further) constraints on this element Element id |
managingOrganization | | | Reference(SMIS Organization Profile) | There are no (further) constraints on this element Element idPatient.managingOrganization Data type Reference(SMIS Organization Profile) Allowed aggregation: referenced |
Structure Definition
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Patient" />
<meta>
<versionId value="3" />
<lastUpdated value="2018-06-05T12:35:42.787+00:00" />
</meta>
<url value="http://smis.ch/fhir/StructureDefinition/Patient" />
<version value="1.0" />
<name value="Patient" />
<title value="SMIS Patient Profile" />
<status value="draft" />
<date value="2018-06-05T12:35:41.688Z" />
<publisher value="Arpage AG" />
<contact>
<name value="Patrick Husi" />
<telecom>
<system value="email" />
<value value="patrick.husi@arpage.ch" />
</telecom>
</contact>
<description value="SMIS Patient Profile" />
<fhirVersion value="3.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Patient" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Patient" />
<derivation value="constraint" />
<differential>
<element id="Patient.name">
<path value="Patient.name" />
<min value="1" />
</element>
<element id="Patient.name.family">
<path value="Patient.name.family" />
<min value="1" />
</element>
<element id="Patient.name.given">
<path value="Patient.name.given" />
<min value="1" />
<max value="1" />
</element>
<element id="Patient.gender">
<path value="Patient.gender" />
<min value="1" />
</element>
<element id="Patient.birthDate">
<path value="Patient.birthDate" />
<min value="1" />
</element>
<element id="Patient.address">
<path value="Patient.address" />
<min value="1" />
</element>
<element id="Patient.address.city">
<path value="Patient.address.city" />
<min value="1" />
</element>
<element id="Patient.address.postalCode">
<path value="Patient.address.postalCode" />
<min value="1" />
</element>
<element id="Patient.animal">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name">
<valueString value="Animal" />
</extension>
<path value="Patient.animal" />
<max value="0" />
</element>
<element id="Patient.managingOrganization">
<path value="Patient.managingOrganization" />
<type>
<code value="Reference" />
<targetProfile value="http://smis.ch/fhir/StructureDefinition/Organization" />
<aggregation value="referenced" />
</type>
</element>
</differential>
</StructureDefinition>
Patient example
{
"resourceType": "Patient",
"id": "1496992819705019",
"meta": {
"lastUpdated": "2017-06-16T09:47:45.000+02:00"
},
"identifier": [
{
"use": "usual",
"system": "http://smis.ch/fhir/patient/internal_id",
"value": "1496992819705019"
},
{
"use": "usual",
"system": "http://smis.ch/fhir/patient/external_id",
"value": "E9EB9096-C848-4355-B15B-15B0B60B9C30"
},
{
"use": "official",
"system": "urn:oid:2.51.1.3",
"value": "756.1234.456.78"
},
{
"use": "official",
"system": "urn:oid:2.16.756.5.30.1.123.100.1",
"value": "1496992819705019"
}
],
"name": [
{
"use": "usual",
"family": "Muster",
"given": [
"Lukas"
]
}
],
"telecom": [
{
"system": "phone",
"value": "+41 12 345 678 99",
"use": "work"
},
{
"system": "phone",
"value": "0799999999",
"use": "home"
},
{
"system": "email",
"value": "martha@muster.ch",
"use": "work"
}
],
"gender": "male",
"birthDate": "1950-01-01",
"address": [
{
"use": "home",
"type": "both",
"line": [
"Niederbipstrs 5"
],
"city": "Niederbipp",
"state": "SO",
"postalCode": "4704",
"country": "CH"
}
],
"contact": [
{
"relationship": [
{
"coding": [
{
"system": "http://hl7.org/fhir/v2/0131",
"code": "N",
"display": "Next-of-Kin"
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "079 123 45 67"
}
],
"address": {
"line": [
"Leopoldstr. 6"
],
"city": "Solothurn",
"postalCode": "4500"
}
},
{
"relationship": [
{
"coding": [
{
"system": "http://hl7.org/fhir/v2/0131",
"code": "E",
"display": "Employer"
}
]
}
],
"name": {
"use": "official",
"text": "Meruba AG"
},
"address": {
"line": [
"Hauptstrasse 16"
],
"city": "Loc",
"postalCode": "1200"
}
}
],
"managingOrganization": {
"reference": "Organization/1457020138649054"
}
}