ph4h

Guía CORE PH4H - RACSEL
0.2 - draft International flag

Publish Box goes here

Resource Profile: LACPatient

Official URL: http://racsel.org/StructureDefinition/LACPatient Version: 0.2
Draft as of 2026-04-29 Computable Name: LACPatient

Patient Summary Patient resource. This profile derives from the International Patient summary with more contraints for the identification of the patients.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from PatientUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: lac-pat-1, lac-pat-2
... Slices for identifier 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type
.... identifier:international S 1..* Identifier An identifier for this patient
..... use 1..1 code fixed to official
Fixed Value: official
..... type 1..1 CodeableConcept Passport number
Fixed Value: As shown (Passport number)
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
..... system 1..1 uri URN OID for the country (ISO-3306 numeric)
.... identifier:national S 1..* Identifier An identifier for this patient
..... type 1..1 CodeableConcept Any type except PPN (Passport number)
Binding: National Identifier Types (required)
..... system 1..1 uri URN OID for the country (ISO-3306 numeric)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier:national.​type Base required National Identifier Types 📦0.2 This IG

Constraints

Id Grade Path(s) Description Expression
lac-pat-1 error Patient A patient can only have a single official identifier Patient.identifier.where(use='official').count() >= 1
lac-pat-2 error Patient The identifier system must be a URN OID Patient.identifier.where(use='official')[0].system.startsWith('urn:oid.2.16.')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: lac-pat-1, lac-pat-2
... 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Σ 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type
.... identifier:international SΣ 1..* Identifier An identifier for this patient
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official
..... type Σ 1..1 CodeableConcept Passport number
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Fixed Value: As shown (Passport number)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system Σ 1..1 uri URN OID for the country (ISO-3306 numeric)
Example General: http://www.acme.com/identifiers/patient
.... identifier:national SΣ 1..* Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Any type except PPN (Passport number)
Binding: National Identifier Types (required)
..... system Σ 1..1 uri URN OID for the country (ISO-3306 numeric)
Example General: http://www.acme.com/identifiers/patient
... name SΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 0..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 SΣ 0..* ContactPoint A contact detail for the individual
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
... generalPractitioner S 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:international.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:international.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:national.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:national.​type Base required National Identifier Types 📦0.2 This IG
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
lac-pat-1 error Patient A patient can only have a single official identifier Patient.identifier.where(use='official').count() >= 1
lac-pat-2 error Patient The identifier system must be a URN OID Patient.identifier.where(use='official')[0].system.startsWith('urn:oid.2.16.')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: lac-pat-1, lac-pat-2
... 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
... text 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
... 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Σ 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type
.... identifier:international SΣ 1..* Identifier An identifier for this patient
..... 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 fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official
..... type Σ 1..1 CodeableConcept Passport number
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Fixed Value: As shown (Passport number)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system Σ 1..1 uri URN OID for the country (ISO-3306 numeric)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:national SΣ 1..* Identifier An identifier for this patient
..... 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 ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Any type except PPN (Passport number)
Binding: National Identifier Types (required)
..... system Σ 1..1 uri URN OID for the country (ISO-3306 numeric)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1
.... 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 ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 0..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 SΣ 0..* ContactPoint A contact detail for the individual
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... 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
Constraints: pat-1
.... 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..* CodeableConceptIPS Concept - reference to a terminology or just text
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.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier:international.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:international.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:national.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:national.​type Base required National Identifier Types 📦0.2 This IG
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
lac-pat-1 error Patient A patient can only have a single official identifier Patient.identifier.where(use='official').count() >= 1
lac-pat-2 error Patient The identifier system must be a URN OID Patient.identifier.where(use='official')[0].system.startsWith('urn:oid.2.16.')
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 PatientUvIps

Summary

Mandatory: 7 elements
Must-Support: 2 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier

Differential View

This structure is derived from PatientUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: lac-pat-1, lac-pat-2
... Slices for identifier 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type
.... identifier:international S 1..* Identifier An identifier for this patient
..... use 1..1 code fixed to official
Fixed Value: official
..... type 1..1 CodeableConcept Passport number
Fixed Value: As shown (Passport number)
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
..... system 1..1 uri URN OID for the country (ISO-3306 numeric)
.... identifier:national S 1..* Identifier An identifier for this patient
..... type 1..1 CodeableConcept Any type except PPN (Passport number)
Binding: National Identifier Types (required)
..... system 1..1 uri URN OID for the country (ISO-3306 numeric)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier:national.​type Base required National Identifier Types 📦0.2 This IG

Constraints

Id Grade Path(s) Description Expression
lac-pat-1 error Patient A patient can only have a single official identifier Patient.identifier.where(use='official').count() >= 1
lac-pat-2 error Patient The identifier system must be a URN OID Patient.identifier.where(use='official')[0].system.startsWith('urn:oid.2.16.')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: lac-pat-1, lac-pat-2
... 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Σ 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type
.... identifier:international SΣ 1..* Identifier An identifier for this patient
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official
..... type Σ 1..1 CodeableConcept Passport number
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Fixed Value: As shown (Passport number)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system Σ 1..1 uri URN OID for the country (ISO-3306 numeric)
Example General: http://www.acme.com/identifiers/patient
.... identifier:national SΣ 1..* Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Any type except PPN (Passport number)
Binding: National Identifier Types (required)
..... system Σ 1..1 uri URN OID for the country (ISO-3306 numeric)
Example General: http://www.acme.com/identifiers/patient
... name SΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 0..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 SΣ 0..* ContactPoint A contact detail for the individual
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
... generalPractitioner S 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:international.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:international.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:national.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:national.​type Base required National Identifier Types 📦0.2 This IG
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
lac-pat-1 error Patient A patient can only have a single official identifier Patient.identifier.where(use='official').count() >= 1
lac-pat-2 error Patient The identifier system must be a URN OID Patient.identifier.where(use='official')[0].system.startsWith('urn:oid.2.16.')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: lac-pat-1, lac-pat-2
... 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
... text 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
... 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Σ 2..* Identifier An identifier for this patient
Slice: Unordered, Open by value:type
.... identifier:international SΣ 1..* Identifier An identifier for this patient
..... 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 fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official
..... type Σ 1..1 CodeableConcept Passport number
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Fixed Value: As shown (Passport number)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... system Σ 1..1 uri URN OID for the country (ISO-3306 numeric)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:national SΣ 1..* Identifier An identifier for this patient
..... 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 ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Any type except PPN (Passport number)
Binding: National Identifier Types (required)
..... system Σ 1..1 uri URN OID for the country (ISO-3306 numeric)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1
.... 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 ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 0..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 SΣ 0..* ContactPoint A contact detail for the individual
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... 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
Constraints: pat-1
.... 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..* CodeableConceptIPS Concept - reference to a terminology or just text
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.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier:international.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:international.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:national.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:national.​type Base required National Identifier Types 📦0.2 This IG
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
lac-pat-1 error Patient A patient can only have a single official identifier Patient.identifier.where(use='official').count() >= 1
lac-pat-2 error Patient The identifier system must be a URN OID Patient.identifier.where(use='official')[0].system.startsWith('urn:oid.2.16.')
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 PatientUvIps

Summary

Mandatory: 7 elements
Must-Support: 2 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier

 

Other representations of profile: CSV, Excel, Schematron