IDEA4RC FHIR Implementation Guide, published by IDEA4RC Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/idea4rc/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/patient-eu-i4rc | Version: 0.1.0 | |||
| Draft as of 2025-09-10 | Computable Name: PatientI4rc | |||
This profile defines how to represent Patient in FHIR for the purpose of the IDEA4RC project.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | Patient | Information about an individual receiving health care services | |
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
0..1 | (Complex) | Race Extension URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc  | |
![]() ![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc" | |
![]() ![]() ![]() ![]()  | 
1..1 | CodeableConcept | Value of extension Binding: Race (required)  | |
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | 
![]() ![]()  | 
Σ | 1..1 | code | Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.  | 
![]() ![]()  | 
Σ | 1..1 | date | The date of birth for the individual | 
![]() ![]()  | 
?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]()  | 
boolean | |||
![]() ![]() ![]()  | 
dateTime | |||
![]() ![]()  | 
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | 
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | 
![]() ![]() ![]()  | 
Σ | 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 | URI | 
| Patient.extension:race.value[x] | required | VsRaceI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/race-i4rcFrom this IG  | |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard  | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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()  | 
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | Patient | Information about an individual receiving health care services | |
![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
0..1 | (Complex) | Race Extension URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc  | |
![]() ![]() ![]() ![]()  | 
1..1 | CodeableConcept | Value of extension Binding: Race (required)  | |
![]() ![]()  | 
1..1 | code | Administrative gender | |
![]() ![]()  | 
1..1 | date | The date of birth for the individual | |
![]() ![]()  | 
||||
![]() ![]() ![]()  | 
0..1 | string | Country of Residence | |
![]() ![]() ![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]() ![]() ![]()  | 
0..1 | (Complex) | code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding  | |
![]() ![]() ![]() ![]() ![]() ![]()  | 
1..1 | Coding | Value of extension Binding: Country: athena (required)  | |
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Patient.extension:race.value[x] | required | VsRaceI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/race-i4rcFrom this IG  | |
| Patient.address.country.extension:countryCode.value[x] | required | VsCountryI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/country-eu-i4rcFrom this IG  | 
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
0..* | Patient | Information about an individual receiving health care services | |||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
0..1 | (Complex) | Race Extension URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc  | |||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..0 | |||||||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc" | |||||
![]() ![]() ![]() ![]()  | 
1..1 | CodeableConcept | Value of extension Binding: Race (required)  | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
Σ | 0..* | Identifier | An identifier for this patient | ||||
![]() ![]()  | 
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]()  | 
Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]()  | 
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]()  | 
Σ | 1..1 | code | Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.  | ||||
![]() ![]()  | 
Σ | 1..1 | date | The date of birth for the individual | ||||
![]() ![]()  | 
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]()  | 
boolean | |||||||
![]() ![]() ![]()  | 
dateTime | |||||||
![]() ![]()  | 
Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132  | ||||
![]() ![]() ![]()  | 
Σ | 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  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | District name (aka county) Example General: Madison  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Postal code for area Example General: 9132  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Country of Residence | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | (Complex) | code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding" | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
1..1 | Coding | Value of extension Binding: Country: athena (required)  | |||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Primitive value for string Max Length:1048576  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}  | ||||
![]() ![]()  | 
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.  | |||||
![]() ![]()  | 
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]()  | 
boolean | |||||||
![]() ![]() ![]()  | 
integer | |||||||
![]() ![]()  | 
0..* | Attachment | Image of the patient | |||||
![]() ![]()  | 
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.  | |||||
![]() ![]() ![]()  | 
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]()  | 
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]()  | 
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]()  | 
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.  | |||||
![]() ![]() ![]()  | 
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]()  | 
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]()  | 
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
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. 
  | |||||
![]() ![]() ![]()  | 
0..1 | boolean | Language preference indicator | |||||
![]() ![]()  | 
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]()  | 
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]()  | 
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]()  | 
Σ | 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 | URI | |||
| Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard 
  | ||||
| Patient.extension:race.value[x] | required | VsRaceI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/race-i4rcFrom this IG  | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard  | ||||
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard  | ||||
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1From the FHIR Standard  | ||||
| Patient.address.country.extension:countryCode.value[x] | required | VsCountryI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/country-eu-i4rcFrom this IG  | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status|4.0.1From the FHIR Standard  | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1From the FHIR Standard  | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard  | ||||
| Patient.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard 
  | ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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()  | |
| 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 Patient
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | Patient | Information about an individual receiving health care services | |
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
0..1 | (Complex) | Race Extension URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc  | |
![]() ![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc" | |
![]() ![]() ![]() ![]()  | 
1..1 | CodeableConcept | Value of extension Binding: Race (required)  | |
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | 
![]() ![]()  | 
Σ | 1..1 | code | Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.  | 
![]() ![]()  | 
Σ | 1..1 | date | The date of birth for the individual | 
![]() ![]()  | 
?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]()  | 
boolean | |||
![]() ![]() ![]()  | 
dateTime | |||
![]() ![]()  | 
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | 
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | 
![]() ![]() ![]()  | 
Σ | 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 | URI | 
| Patient.extension:race.value[x] | required | VsRaceI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/race-i4rcFrom this IG  | |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard  | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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()  | 
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | Patient | Information about an individual receiving health care services | |
![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
0..1 | (Complex) | Race Extension URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc  | |
![]() ![]() ![]() ![]()  | 
1..1 | CodeableConcept | Value of extension Binding: Race (required)  | |
![]() ![]()  | 
1..1 | code | Administrative gender | |
![]() ![]()  | 
1..1 | date | The date of birth for the individual | |
![]() ![]()  | 
||||
![]() ![]() ![]()  | 
0..1 | string | Country of Residence | |
![]() ![]() ![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]() ![]() ![]()  | 
0..1 | (Complex) | code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding  | |
![]() ![]() ![]() ![]() ![]() ![]()  | 
1..1 | Coding | Value of extension Binding: Country: athena (required)  | |
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Patient.extension:race.value[x] | required | VsRaceI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/race-i4rcFrom this IG  | |
| Patient.address.country.extension:countryCode.value[x] | required | VsCountryI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/country-eu-i4rcFrom this IG  | 
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
0..* | Patient | Information about an individual receiving health care services | |||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
0..1 | (Complex) | Race Extension URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc  | |||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..0 | |||||||
![]() ![]() ![]() ![]()  | 
1..1 | uri | "http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/Race-eu-i4rc" | |||||
![]() ![]() ![]() ![]()  | 
1..1 | CodeableConcept | Value of extension Binding: Race (required)  | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
Σ | 0..* | Identifier | An identifier for this patient | ||||
![]() ![]()  | 
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]()  | 
Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]()  | 
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]()  | 
Σ | 1..1 | code | Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.  | ||||
![]() ![]()  | 
Σ | 1..1 | date | The date of birth for the individual | ||||
![]() ![]()  | 
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]()  | 
boolean | |||||||
![]() ![]() ![]()  | 
dateTime | |||||||
![]() ![]()  | 
Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132  | ||||
![]() ![]() ![]()  | 
Σ | 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  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | District name (aka county) Example General: Madison  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Postal code for area Example General: 9132  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Country of Residence | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]() ![]()  | 
0..1 | (Complex) | code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding  | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding" | |||||
![]() ![]() ![]() ![]() ![]() ![]()  | 
1..1 | Coding | Value of extension Binding: Country: athena (required)  | |||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Primitive value for string Max Length:1048576  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}  | ||||
![]() ![]()  | 
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.  | |||||
![]() ![]()  | 
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]()  | 
boolean | |||||||
![]() ![]() ![]()  | 
integer | |||||||
![]() ![]()  | 
0..* | Attachment | Image of the patient | |||||
![]() ![]()  | 
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.  | |||||
![]() ![]() ![]()  | 
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]()  | 
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]()  | 
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]()  | 
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.  | |||||
![]() ![]() ![]()  | 
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]()  | 
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]()  | 
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
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. 
  | |||||
![]() ![]() ![]()  | 
0..1 | boolean | Language preference indicator | |||||
![]() ![]()  | 
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]()  | 
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]()  | 
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]()  | 
Σ | 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 | URI | |||
| Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard 
  | ||||
| Patient.extension:race.value[x] | required | VsRaceI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/race-i4rcFrom this IG  | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard  | ||||
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard  | ||||
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1From the FHIR Standard  | ||||
| Patient.address.country.extension:countryCode.value[x] | required | VsCountryI4rchttp://hl7.eu/fhir/ig/idea4rc/ValueSet/country-eu-i4rcFrom this IG  | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status|4.0.1From the FHIR Standard  | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1From the FHIR Standard  | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard  | ||||
| Patient.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard 
  | ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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()  | |
| 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 Patient
Other representations of profile: CSV, Excel, Schematron