Your User Friendly Name for MyIG Here
0.2.0 - CI Build International flag

Your User Friendly Name for MyIG Here, published by HL7 International - [Some] Work Group. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/sample-ig/ and changes regularly. See the Directory of published versions

Resource Profile: My Favorite Patient Profile

Official URL: http://somewhere.org/fhir/uv/myig/StructureDefinition/mypatient Version: 0.2.0
Standards status: Informative Maturity Level: 1 Computable Name: MyPatientName

This will be the description for the patient profile within the profile page

Introductory guidance on the patient profile

  • Demonstration of new content

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient My Favorite Patient Profile
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:myExtension 0..1 boolean Context-specific Extension Name
URL: http://somewhere.org/fhir/uv/myig/StructureDefinition/ext-myExtension
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element is included in summaries. 0..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use, exists:period.end

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:CurrentOfficial This element must be supported. This element is included in summaries. 1..1 HumanName A name associated with the patient
Patient.Slices for name.name:CurrentOfficial.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:CurrentOfficial.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 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.name:CurrentOfficial.​use Base required NameUse 📍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()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient My Favorite Patient Profile
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:myExtension 0..1 boolean Context-specific Extension Name
URL: http://somewhere.org/fhir/uv/myig/StructureDefinition/ext-myExtension
Patient.Slices for name 0..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use, exists:period.end
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:CurrentOfficial This element must be supported. 1..1 HumanName A name associated with the patient
Patient.Slices for name.name:CurrentOfficial.use This element must be supported. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:CurrentOfficial.period 0..1 Period Time period when name was/is in use
Patient.Slices for name.name:CurrentOfficial.period.end This element must be supported. 0..0 End time with inclusive boundary, if not ongoing

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient My Favorite Patient Profile
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:myExtension 0..1 boolean Context-specific Extension Name
URL: http://somewhere.org/fhir/uv/myig/StructureDefinition/ext-myExtension
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element is included in summaries. 0..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use, exists:period.end

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:CurrentOfficial This element must be supported. This element is included in summaries. 1..1 HumanName A name associated with the patient
Patient.Slices for name.name:CurrentOfficial.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:CurrentOfficial.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:CurrentOfficial.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:CurrentOfficial.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:CurrentOfficial.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.Slices for name.name:CurrentOfficial.given This element is included in summaries. 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
Patient.Slices for name.name:CurrentOfficial.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:CurrentOfficial.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:CurrentOfficial.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.Slices for name.name:CurrentOfficial.period.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:CurrentOfficial.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:CurrentOfficial.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.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
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 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.name:CurrentOfficial.​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()
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

Summary

Mandatory: 2 elements
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Patient.name

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient My Favorite Patient Profile
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:myExtension 0..1 boolean Context-specific Extension Name
URL: http://somewhere.org/fhir/uv/myig/StructureDefinition/ext-myExtension
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element is included in summaries. 0..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use, exists:period.end

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:CurrentOfficial This element must be supported. This element is included in summaries. 1..1 HumanName A name associated with the patient
Patient.Slices for name.name:CurrentOfficial.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:CurrentOfficial.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 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.name:CurrentOfficial.​use Base required NameUse 📍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()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient My Favorite Patient Profile
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:myExtension 0..1 boolean Context-specific Extension Name
URL: http://somewhere.org/fhir/uv/myig/StructureDefinition/ext-myExtension
Patient.Slices for name 0..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use, exists:period.end
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:CurrentOfficial This element must be supported. 1..1 HumanName A name associated with the patient
Patient.Slices for name.name:CurrentOfficial.use This element must be supported. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:CurrentOfficial.period 0..1 Period Time period when name was/is in use
Patient.Slices for name.name:CurrentOfficial.period.end This element must be supported. 0..0 End time with inclusive boundary, if not ongoing

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient My Favorite Patient Profile
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:myExtension 0..1 boolean Context-specific Extension Name
URL: http://somewhere.org/fhir/uv/myig/StructureDefinition/ext-myExtension
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element is included in summaries. 0..* Identifier An identifier for this patient
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element is included in summaries. 0..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use, exists:period.end

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:CurrentOfficial This element must be supported. This element is included in summaries. 1..1 HumanName A name associated with the patient
Patient.Slices for name.name:CurrentOfficial.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:CurrentOfficial.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:CurrentOfficial.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:CurrentOfficial.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:CurrentOfficial.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.Slices for name.name:CurrentOfficial.given This element is included in summaries. 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
Patient.Slices for name.name:CurrentOfficial.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:CurrentOfficial.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:CurrentOfficial.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.Slices for name.name:CurrentOfficial.period.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:CurrentOfficial.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:CurrentOfficial.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.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
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 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.name:CurrentOfficial.​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()
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

Summary

Mandatory: 2 elements
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Patient.name

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Usage notes on the patient profile