eHealth Infrastructure (v2020.1)
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-skrs-patient
This profile builds on Patient.
This profile was published on Tue Feb 04 09:11:17 UTC 2020 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Patient
Summary
Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | Patient | |||
  extension | Slice: Unordered, Open by value:url | |||
 extension:nameAndAddressProtection | ..1 | ?? [CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection]] | URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection | |
 identifier | 1..1 | (Slice Definition) | Slice: Unordered, Open by value:system | |
  identifier:dk-civil-registration-number | 1..1 | DK CRN Identifier | Fixed Value: As shown | |
   use | 1..1 | code | usual | official | temp | secondary (If known) Fixed Value: official | |
 deceasedDateTime:deceasedDateTime | dateTime | |||
| address | ..1 | (Slice Definition) | Slice: Unordered, Closed by value:use | |
| address:officialHomeAddress | ..1 | DanishAddress | ||
  extension:regionalSubdivisionCode | ||||
  valueCodeableConcept | ||||
 coding | (Slice Definition) | Slice: Unordered, Open by value:system | ||
| use | Fixed Value: home | |||
| animal | ..0 | |||
| Documentation for this format | ||||
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Patient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
 id | ΣI | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
 meta | ΣI | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| language | I | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages ele-1: All FHIR elements must have a @value or children |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension:nameAndAddressProtection | I | 0..1 | ?? [CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection]] | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension | ?!I | 0..* | (Slice Definition) | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier | ΣI | 1..1 | (Slice Definition) | An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
| identifier:dk-civil-registration-number | ΣI | 1..1 | DK CRN Identifier | An identifier intended for computation ele-1: All FHIR elements must have a @value or children Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| extension | 0..0 | Extension | Additional Content defined by implementations | |
| use | 1..1 | code | usual | official | temp | secondary (If known) Fixed Value: official | |
| type | 0..0 | CodeableConcept | Description of identifier | |
| system | 0..0 | uri | The namespace for the identifier value | |
| value | 0..0 | string | The value that is unique | |
| period | 0..0 | Period | Time period when id is/was valid for use | |
| assigner | 0..0 | Reference(Organization) | Organization that issued id (may be just text) | |
| active | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
| name | ΣI | 0..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children |
| telecom | ΣI | 0..* | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided. |
| gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children |
| birthDate | ΣI | 0..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children |
| deceasedDateTime:deceasedDateTime | ?!ΣI | 0..1 | dateTime | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children |
| address | ΣI | 0..1 | (Slice Definition) | Addresses for the individual Slice: Unordered, Closed by value:use ele-1: All FHIR elements must have a @value or children |
| address:officialHomeAddress | ΣI | 0..1 | DanishAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| ehealth-municipality-code | I | 0..1 | Coding | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-municipality-code ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| ehealth-regional-subdivision-code | I | 0..1 | CodeableConcept | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-regional-subdivision-code ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| url | I | 1..1 | uri | "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-regional-subdivision-code" |
| valueCodeableConcept:valueCodeableConcept | I | 0..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
| coding:regionalCode | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.iso.org/obp/ui/#iso:code:3166:DK |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| use | ?!ΣI | 1..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) ele-1: All FHIR elements must have a @value or children Fixed Value: home |
| type | ΣI | 0..1 | code | postal | physical | both Binding: AddressType (required) ele-1: All FHIR elements must have a @value or children Example General: both |
| text | ΣI | 0..1 | string | Text representation of the address ele-1: All FHIR elements must have a @value or children Example General: 137 Nowhere Street, Erewhon 9132 |
| line | ΣI | 0..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city | ΣI | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon |
| postalCode | ΣI | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 |
| country | ΣI | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children |
| period | ΣI | 0..1 | Period | Time period when address was/is in use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"} |
| maritalStatus | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) ele-1: All FHIR elements must have a @value or children |
 multipleBirth[x] | I | 0..1 | Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children | |
| multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| photo | I | 0..* | Attachment | Image of the patient ele-1: All FHIR elements must have a @value or children att-1: It the Attachment has data, it SHALL have a contentType |
| contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| relationship | I | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (extensible) ele-1: All FHIR elements must have a @value or children |
| name | I | 0..1 | HumanName | A name associated with the contact person ele-1: All FHIR elements must have a @value or children |
| telecom | I | 0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided. |
| address | I | 0..1 | Address | Address for the contact person ele-1: All FHIR elements must have a @value or children |
| gender | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children |
 organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| period | I | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| communication | I | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| language | I | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (extensible) Max Binding: All Languages ele-1: All FHIR elements must have a @value or children |
| preferred | I | 0..1 | boolean | Language preference indicator ele-1: All FHIR elements must have a @value or children |
| generalPractitioner | I | 0..* | Reference(Organization | Practitioner) | Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| managingOrganization | ΣI | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| link | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| other | ΣI | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| type | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
This structure is derived from Patient
Summary
Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | Patient | |||
| extension | Slice: Unordered, Open by value:url | |||
| extension:nameAndAddressProtection | ..1 | ?? [CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection]] | URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection | |
| identifier | 1..1 | (Slice Definition) | Slice: Unordered, Open by value:system | |
| identifier:dk-civil-registration-number | 1..1 | DK CRN Identifier | Fixed Value: As shown | |
| use | 1..1 | code | usual | official | temp | secondary (If known) Fixed Value: official | |
| deceasedDateTime:deceasedDateTime | dateTime | |||
| address | ..1 | (Slice Definition) | Slice: Unordered, Closed by value:use | |
| address:officialHomeAddress | ..1 | DanishAddress | ||
| extension:regionalSubdivisionCode | ||||
| valueCodeableConcept | ||||
| coding | (Slice Definition) | Slice: Unordered, Open by value:system | ||
| use | Fixed Value: home | |||
| animal | ..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | Patient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
| id | ΣI | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
| meta | ΣI | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| language | I | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages ele-1: All FHIR elements must have a @value or children |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension:nameAndAddressProtection | I | 0..1 | ?? [CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection]] | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-nameandaddressprotection ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension | ?!I | 0..* | (Slice Definition) | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier | ΣI | 1..1 | (Slice Definition) | An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
| identifier:dk-civil-registration-number | ΣI | 1..1 | DK CRN Identifier | An identifier intended for computation ele-1: All FHIR elements must have a @value or children Fixed Value: As shown |
| id | 0..0 | string | xml:id (or equivalent in JSON) | |
| extension | 0..0 | Extension | Additional Content defined by implementations | |
| use | 1..1 | code | usual | official | temp | secondary (If known) Fixed Value: official | |
| type | 0..0 | CodeableConcept | Description of identifier | |
| system | 0..0 | uri | The namespace for the identifier value | |
| value | 0..0 | string | The value that is unique | |
| period | 0..0 | Period | Time period when id is/was valid for use | |
| assigner | 0..0 | Reference(Organization) | Organization that issued id (may be just text) | |
| active | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
| name | ΣI | 0..* | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children |
| telecom | ΣI | 0..* | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided. |
| gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children |
| birthDate | ΣI | 0..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children |
| deceasedDateTime:deceasedDateTime | ?!ΣI | 0..1 | dateTime | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children |
| address | ΣI | 0..1 | (Slice Definition) | Addresses for the individual Slice: Unordered, Closed by value:use ele-1: All FHIR elements must have a @value or children |
| address:officialHomeAddress | ΣI | 0..1 | DanishAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| ehealth-municipality-code | I | 0..1 | Coding | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-municipality-code ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| ehealth-regional-subdivision-code | I | 0..1 | CodeableConcept | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-regional-subdivision-code ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| url | I | 1..1 | uri | "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-regional-subdivision-code" |
| valueCodeableConcept:valueCodeableConcept | I | 0..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
| coding:regionalCode | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.iso.org/obp/ui/#iso:code:3166:DK |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| use | ?!ΣI | 1..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) ele-1: All FHIR elements must have a @value or children Fixed Value: home |
| type | ΣI | 0..1 | code | postal | physical | both Binding: AddressType (required) ele-1: All FHIR elements must have a @value or children Example General: both |
| text | ΣI | 0..1 | string | Text representation of the address ele-1: All FHIR elements must have a @value or children Example General: 137 Nowhere Street, Erewhon 9132 |
| line | ΣI | 0..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city | ΣI | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon |
| postalCode | ΣI | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 |
| country | ΣI | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children |
| period | ΣI | 0..1 | Period | Time period when address was/is in use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"} |
| maritalStatus | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| multipleBirth[x] | I | 0..1 | Whether patient is part of a multiple birth ele-1: All FHIR elements must have a @value or children | |
| multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| photo | I | 0..* | Attachment | Image of the patient ele-1: All FHIR elements must have a @value or children att-1: It the Attachment has data, it SHALL have a contentType |
| contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| relationship | I | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (extensible) ele-1: All FHIR elements must have a @value or children |
| name | I | 0..1 | HumanName | A name associated with the contact person ele-1: All FHIR elements must have a @value or children |
| telecom | I | 0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided. |
| address | I | 0..1 | Address | Address for the contact person ele-1: All FHIR elements must have a @value or children |
| gender | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children |
| organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| period | I | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| communication | I | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| language | I | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (extensible) Max Binding: All Languages ele-1: All FHIR elements must have a @value or children |
| preferred | I | 0..1 | boolean | Language preference indicator ele-1: All FHIR elements must have a @value or children |
| generalPractitioner | I | 0..* | Reference(Organization | Practitioner) | Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| managingOrganization | ΣI | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| link | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| other | ΣI | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| type | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Patient.language | extensible | Common Languages Max Binding: All Languages |
| Patient.gender | required | AdministrativeGender |
| Patient.address:officialHomeAddress.use | required | Fixed Value: home |
| Patient.address:officialHomeAddress.type | required | AddressType |
| Patient.maritalStatus | extensible | Marital Status Codes |
| Patient.contact.relationship | extensible | v2 Contact Role |
| Patient.contact.gender | required | AdministrativeGender |
| Patient.animal.species | example | AnimalSpecies |
| Patient.animal.breed | example | AnimalBreeds |
| Patient.animal.genderStatus | example | GenderStatus |
| Patient.communication.language | extensible | Common Languages Max Binding: All Languages |
| Patient.link.type | required | LinkType |
| Id | Path | Details | Requirements |
| dom-2 | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | 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-3 | Patient | 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() | |
| ele-1 | Patient.id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:nameAndAddressProtection | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:nameAndAddressProtection | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.identifier:dk-civil-registration-number | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| cpt-2 | Patient.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| ele-1 | Patient.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.deceased[x]:deceasedDateTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.address:officialHomeAddress.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.address:officialHomeAddress.extension:municipalityCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.address:officialHomeAddress.extension:municipalityCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.valueCodeableConcept:valueCodeableConcept.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.coding:regionalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.coding:regionalCode.id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.coding:regionalCode.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.coding:regionalCode.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.coding:regionalCode.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.coding:regionalCode.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.coding:regionalCode.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.coding:regionalCode.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.coding:regionalCode.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.extension:regionalSubdivisionCode.value[x]:valueCodeableConcept.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address:officialHomeAddress.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| per-1 | Patient.address:officialHomeAddress.period | If present, start SHALL have a lower value than end : start.empty() or end.empty() or (start <= end) | |
| ele-1 | Patient.maritalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.multipleBirth[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| att-1 | Patient.photo | It the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| ele-1 | Patient.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pat-1 | 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() | |
| ele-1 | Patient.contact.id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.contact.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| cpt-2 | Patient.contact.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| ele-1 | Patient.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ref-1 | Patient.contact.organization | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) | |
| ele-1 | Patient.contact.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| per-1 | Patient.contact.period | If present, start SHALL have a lower value than end : start.empty() or end.empty() or (start <= end) | |
| ele-1 | Patient.animal.id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.animal.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.animal.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.animal.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.animal.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.animal.species | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.animal.breed | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.animal.genderStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication.id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.generalPractitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ref-1 | Patient.generalPractitioner | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) | |
| ele-1 | Patient.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ref-1 | Patient.managingOrganization | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) | |
| ele-1 | Patient.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link.id | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.link.other | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ref-1 | Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) | |
| ele-1 | Patient.link.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |