Danish MedCom Core
2.3.0 - Release
Danish MedCom Core
2.3.0 - Release
This page is part of the DK MedCom Core (v2.3.0: Release) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://medcomfhir.dk/ig/core/StructureDefinition/medcom-core-patient | Version: 2.3.0 | |||
| Active as of 2023-10-31 | Computable Name: MedComCorePatient | |||
Patient/citizen resource to use as subject in MedCom communication.
MedComCorePatient profile describes information about a patient or citizen in a MedCom standard. The MedComCorePatient is inherited from the DkCorePatient profile defined by HL7 Denmark. An identifier and the patients official family name (‘efternavn’ in Danish) shall both be present, when exchanging patient related information.
Please refer to the tab “Snapshot Table(Must support)” below for the definition of the required content of a MedComCorePatient.
A MedComCorePatient shall include an identifier, containing a value which is the actual id and a system which is used to identify a set of unique values.
When a patient has an official civil person register (CPR)-number this shall be used. To represent a CPR-number, the identifier DkCoreCprIdentifier shall be used. In the identifier the system is used to describes that value is an official CPR-number, as described on cpr.dk.
Only in cases where the patient does not have an official CPR-number, a replacement person identifier (Danish: Erstatningspersonnummer) (eCPR)-number shall be used. To represent an eCPR-number the identifier MedComCoreECprIdentifier shall be used. The identifier shall include a value of maximum 10 values and a system. Currently, it is possible to use the national eCPR register defined by the Danish health Data Authority as system. However, the list of possible systems for eCPR-numbers may be extended if there is consensus between stakeholder to add another system to the ValueSet.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DkCorePatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | DkCorePatient | Information about an individual or animal receiving health care services | |
  identifier | S | 1..* | Identifier | An identifier for this patient |
 identifier:cpr | SΣ | 0..1 | DkCoreCprIdentifier | Unique identification number for all citizens in Denmark, called civil person register (CPR-number). |
| identifier:ecpr | S | 0..1 | MedComCoreECprIdentifier | Replacement person identifier (E-CPR). This identifier must only be used in cases where a person does not have an official CPR-number. |
| name | S | 1..* | HumanName | A name associated with the patient |
 name:official | S | 1..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret |
  family | S | 1..1 | string | Family name (often called 'Surname') |
 given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
 telecom | S | 0..* | MedComMessagingContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| deceased[x] | S | 0..1 | boolean, dateTime | Shall only be sent if the patient is deceased or the status change from deceased to non-deceased |
| address | S | 0..* | Address | An address for the individual |
| line | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
| city | S | 0..1 | string | Name of city, town etc. |
 postalCode | S | 0..1 | string | Postal code for area |
 managingOrganization | 0..1 | Reference(MedComCoreOrganization) {b} | Organization that is the custodian of the patient record | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | C | 0..* | DkCorePatient | Information about an individual or animal receiving health care services |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
 identifier:cpr | SΣ | 0..1 | DkCoreCprIdentifier | Unique identification number for all citizens in Denmark, called civil person register (CPR-number). |
 identifier:ecpr | SΣ | 0..1 | MedComCoreECprIdentifier | Replacement person identifier (E-CPR). This identifier must only be used in cases where a person does not have an official CPR-number. |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
 name:official | SΣ | 1..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret |
 use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
| family | SΣ | 1..1 | string | Family name (often called 'Surname') |
| given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| telecom | SC | 0..* | MedComMessagingContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
 deceased[x] | ?!SΣ | 0..1 | Shall only be sent if the patient is deceased or the status change from deceased to non-deceased | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | SΣ | 0..* | Address | An address for the individual |
| municipalityCode | 0..1 | CodeableConcept | [DA] Kommunekode URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes | |
| regionalSubDivisionCodes | 0..1 | CodeableConcept | [DA] Regionskode URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
| Slices for generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by value:identifier.system | |
| generalPractitioner:referencedSORUnit | 0..* | Reference(Organization | Practitioner | PractitionerRole) | [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau | |
| managingOrganization | Σ | 0..1 | Reference(MedComCoreOrganization) {b} | Organization that is the custodian of the patient record |
 link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Patient.name:official.use | required | Fixed Value: official |
| Patient.address.use | required | AddressUse |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| marital-status-unknown-usage | warning | Patient | Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK : maritalStatus.coding.where(code = 'P' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty() or maritalStatus.coding.where(code = 'A' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | C | 0..* | DkCorePatient | Information about an individual or animal receiving health care services | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
| identifier:cpr | SΣ | 0..1 | DkCoreCprIdentifier | Unique identification number for all citizens in Denmark, called civil person register (CPR-number). | ||||
| identifier:ecpr | SΣ | 0..1 | MedComCoreECprIdentifier | Replacement person identifier (E-CPR). This identifier must only be used in cases where a person does not have an official CPR-number. | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
| name:official | SΣ | 1..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | SC | 0..* | MedComMessagingContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] | ?!SΣ | 0..1 | Shall only be sent if the patient is deceased or the status change from deceased to non-deceased | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | SΣ | 0..* | Address | An address for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| municipalityCode | 0..1 | CodeableConcept | [DA] Kommunekode URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes | |||||
| regionalSubDivisionCodes | 0..1 | CodeableConcept | [DA] Regionskode URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: DK MaritalStatus (extensible) | |||||
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Slices for generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by value:identifier.system | |||||
| generalPractitioner:referencedSORUnit | 0..* | Reference(Organization | Practitioner | PractitionerRole) | [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | 0..1 | SORIdentifier | An identifier intended for computation | |||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| managingOrganization | Σ | 0..1 | Reference(MedComCoreOrganization) {b} | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.name:official.use | required | Fixed Value: official | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.address.use | required | AddressUse | ||||
| Patient.address.type | required | AddressType | ||||
| Patient.maritalStatus | extensible | |||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.generalPractitioner:referencedSORUnit.type | extensible | ResourceType | ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| marital-status-unknown-usage | warning | Patient | Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK : maritalStatus.coding.where(code = 'P' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty() or maritalStatus.coding.where(code = 'A' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty() | |
| pat-1 | error | Patient.contact | 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() |
This structure is derived from DkCorePatient
Summary
Mandatory: 2 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from DkCorePatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | DkCorePatient | Information about an individual or animal receiving health care services | |
| identifier | S | 1..* | Identifier | An identifier for this patient |
| identifier:cpr | SΣ | 0..1 | DkCoreCprIdentifier | Unique identification number for all citizens in Denmark, called civil person register (CPR-number). |
| identifier:ecpr | S | 0..1 | MedComCoreECprIdentifier | Replacement person identifier (E-CPR). This identifier must only be used in cases where a person does not have an official CPR-number. |
| name | S | 1..* | HumanName | A name associated with the patient |
| name:official | S | 1..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret |
| family | S | 1..1 | string | Family name (often called 'Surname') |
| given | S | 0..* | string | Given names (not always 'first'). Includes middle names |
| telecom | S | 0..* | MedComMessagingContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| deceased[x] | S | 0..1 | boolean, dateTime | Shall only be sent if the patient is deceased or the status change from deceased to non-deceased |
| address | S | 0..* | Address | An address for the individual |
| line | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
| city | S | 0..1 | string | Name of city, town etc. |
| postalCode | S | 0..1 | string | Postal code for area |
| managingOrganization | 0..1 | Reference(MedComCoreOrganization) {b} | Organization that is the custodian of the patient record | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | C | 0..* | DkCorePatient | Information about an individual or animal receiving health care services |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
| identifier:cpr | SΣ | 0..1 | DkCoreCprIdentifier | Unique identification number for all citizens in Denmark, called civil person register (CPR-number). |
| identifier:ecpr | SΣ | 0..1 | MedComCoreECprIdentifier | Replacement person identifier (E-CPR). This identifier must only be used in cases where a person does not have an official CPR-number. |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
| name:official | SΣ | 1..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret |
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
| family | SΣ | 1..1 | string | Family name (often called 'Surname') |
| given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| telecom | SC | 0..* | MedComMessagingContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| deceased[x] | ?!SΣ | 0..1 | Shall only be sent if the patient is deceased or the status change from deceased to non-deceased | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | SΣ | 0..* | Address | An address for the individual |
| municipalityCode | 0..1 | CodeableConcept | [DA] Kommunekode URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes | |
| regionalSubDivisionCodes | 0..1 | CodeableConcept | [DA] Regionskode URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
| Slices for generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by value:identifier.system | |
| generalPractitioner:referencedSORUnit | 0..* | Reference(Organization | Practitioner | PractitionerRole) | [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau | |
| managingOrganization | Σ | 0..1 | Reference(MedComCoreOrganization) {b} | Organization that is the custodian of the patient record |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Patient.name:official.use | required | Fixed Value: official |
| Patient.address.use | required | AddressUse |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| marital-status-unknown-usage | warning | Patient | Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK : maritalStatus.coding.where(code = 'P' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty() or maritalStatus.coding.where(code = 'A' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | C | 0..* | DkCorePatient | Information about an individual or animal receiving health care services | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
| identifier:cpr | SΣ | 0..1 | DkCoreCprIdentifier | Unique identification number for all citizens in Denmark, called civil person register (CPR-number). | ||||
| identifier:ecpr | SΣ | 0..1 | MedComCoreECprIdentifier | Replacement person identifier (E-CPR). This identifier must only be used in cases where a person does not have an official CPR-number. | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
| name:official | SΣ | 1..1 | HumanName | [DA] Officielt navn, som det fremgår af CPR registeret | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | SC | 0..* | MedComMessagingContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] | ?!SΣ | 0..1 | Shall only be sent if the patient is deceased or the status change from deceased to non-deceased | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | SΣ | 0..* | Address | An address for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| municipalityCode | 0..1 | CodeableConcept | [DA] Kommunekode URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-municipalityCodes | |||||
| regionalSubDivisionCodes | 0..1 | CodeableConcept | [DA] Regionskode URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-RegionalSubDivisionCodes | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: DK MaritalStatus (extensible) | |||||
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Slices for generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider Slice: Unordered, Open by value:identifier.system | |||||
| generalPractitioner:referencedSORUnit | 0..* | Reference(Organization | Practitioner | PractitionerRole) | [DA] Praktiserende læges SOR-id på sundhedsinstistutionsniveau | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | 0..1 | SORIdentifier | An identifier intended for computation | |||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| managingOrganization | Σ | 0..1 | Reference(MedComCoreOrganization) {b} | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.name:official.use | required | Fixed Value: official | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.address.use | required | AddressUse | ||||
| Patient.address.type | required | AddressType | ||||
| Patient.maritalStatus | extensible | |||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.generalPractitioner:referencedSORUnit.type | extensible | ResourceType | ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| marital-status-unknown-usage | warning | Patient | Status in maritalStatus is unknown in a danish context. Consider mapping the value to UNK : maritalStatus.coding.where(code = 'P' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty() or maritalStatus.coding.where(code = 'A' and system = 'http://terminology.hl7.org/CodeSystem/v3-MaritalStatus').empty() | |
| pat-1 | error | Patient.contact | 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() |
This structure is derived from DkCorePatient
Summary
Mandatory: 2 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ MedCom. Package medcom.fhir.dk.core#2.3.0 based on FHIR 4.0.1. Generated 2023-10-31
Links: Table of Contents |
QA Report