HL7 Europe Common Cancer Model
1.0.0-ballot - ballot 150

HL7 Europe Common Cancer Model, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/cancer-common/ and changes regularly. See the Directory of published versions

Resource Profile: Patient (CCM)

Official URL: http://hl7.eu/fhir/cancer-common/StructureDefinition/patient-eu-ccm Version: 1.0.0-ballot
Standards status: Informative Maturity Level: 0 Computable Name: PatientEuCcm

Copyright/Legal: HL7 Europe Copyright. Licensed under Common Creative License (CC0 1.0). Details at Copyright.

This informative profile defines how to represent Patient in FHIR for the purpose of the ECCDM. It is provided as future implementation-oriented content in this publication and is expected to evolve in subsequent iterations of this guide.

Future implementation content This generated FHIR profile is provided as informative implementation-oriented content in this publication and is expected to evolve in subsequent iterations of this guide.

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.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientEu Information about an individual receiving health care services
Constraints: recordedSexOrGender-or-gender
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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 AddressEu The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.Slices for extension.extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value 1..1 Extension The recorded sex or gender property for the individual

Example sex-assigned-at-birth: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.url 1..1 uri "value"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.value[x] 1..1 CodeableConcept Value of extension
Binding: AdministrativeGender (example)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type 1..1 Extension Type of recorded sex or gender.

Example sex-assigned-at-birth: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.url 1..1 uri "type"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.url 1..1 uri "effectivePeriod"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.url 1..1 uri "acquisitionDate"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.value[x] 1..1 dateTime Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.url 1..1 uri "source"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x] 1..1 Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x].valueCodeableConcept CodeableConcept
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x].valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.url 1..1 uri "sourceDocument"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x] 1..1 Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x].valueCodeableConcept CodeableConcept
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x].valueReference Reference(DocumentReference)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.url 1..1 uri "sourceField"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.value[x] 1..1 string Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.url 1..1 uri "jurisdiction"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment 0..1 Extension Context or source information about the recorded sex or gender
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.url 1..1 uri "comment"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.value[x] 1..1 string Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.url 1..1 uri "genderElementQualifier"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.value[x] 1..1 boolean Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
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.gender This element is included in summaries. 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..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.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.extension:recordedSexOrGender.​extension:value.value[x] Base example AdministrativeGender 📦4.0.1 FHIR Std.
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.4
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.4
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()
recordedSexOrGender-or-gender error Patient If recordedSexOrGender extension is not present, gender shall be valued. extension.where(url = 'http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').exists() or gender.exists()

This structure is derived from PatientEu

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientEu Information about an individual receiving health care services
Constraints: recordedSexOrGender-or-gender
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:recordedSexOrGender.extension 2..* Extension Extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value 1..1 Extension The recorded sex or gender property for the individual
Example sex-assigned-at-birth: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type 1..1 Extension Type of recorded sex or gender.
Example sex-assigned-at-birth: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
Patient.gender 0..1 code Administrative gender
Patient.birthDate 1..1 date The date of birth for the individual

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
recordedSexOrGender-or-gender error Patient If recordedSexOrGender extension is not present, gender shall be valued. extension.where(url = 'http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').exists() or gender.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientEu Information about an individual receiving health care services
Constraints: recordedSexOrGender-or-gender
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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id 0..1 id Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 AddressEu The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.Slices for extension.extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:recordedSexOrGender.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value 1..1 Extension The recorded sex or gender property for the individual

Example sex-assigned-at-birth: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.url 1..1 uri "value"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.value[x] 1..1 CodeableConcept Value of extension
Binding: AdministrativeGender (example)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type 1..1 Extension Type of recorded sex or gender.

Example sex-assigned-at-birth: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.url 1..1 uri "type"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.url 1..1 uri "effectivePeriod"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.value[x] 0..1 Period Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.url 1..1 uri "acquisitionDate"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.value[x] 1..1 dateTime Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.url 1..1 uri "source"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x] 1..1 Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x].valueCodeableConcept CodeableConcept
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x].valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.url 1..1 uri "sourceDocument"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x] 1..1 Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x].valueCodeableConcept CodeableConcept
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x].valueReference Reference(DocumentReference)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.url 1..1 uri "sourceField"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.value[x] 1..1 string Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.url 1..1 uri "jurisdiction"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment 0..1 Extension Context or source information about the recorded sex or gender
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.url 1..1 uri "comment"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.value[x] 1..1 string Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.url 1..1 uri "genderElementQualifier"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.value[x] 1..1 boolean Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
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 Patient identifiers
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.name This element is included in summaries. 0..* HumanName A name associated with the patient
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name.
Patient.name.family This element is included in summaries. 0..1 string Family name.
Example spanish: Valero Iglesias
Patient.name.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.name.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.name.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.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the patient
Patient.gender This element is included in summaries. 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..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..* AddressEu The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital status
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 Contact 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 Contact name
Patient.contact.telecom 0..* ContactPoint Contact details for the person
Patient.contact.address 0..1 AddressEu The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Contact person address
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 Communication language
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.extension:recordedSexOrGender.​extension:value.value[x] Base example AdministrativeGender 📦4.0.1 FHIR Std.
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.4
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.4
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()
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()
recordedSexOrGender-or-gender error Patient If recordedSexOrGender extension is not present, gender shall be valued. extension.where(url = 'http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').exists() or gender.exists()

This structure is derived from PatientEu

Summary

Mandatory: 1 element(1 nested mandatory element)

Extensions

This structure refers to these extensions:

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientEu Information about an individual receiving health care services
Constraints: recordedSexOrGender-or-gender
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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 AddressEu The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.Slices for extension.extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value 1..1 Extension The recorded sex or gender property for the individual

Example sex-assigned-at-birth: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.url 1..1 uri "value"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.value[x] 1..1 CodeableConcept Value of extension
Binding: AdministrativeGender (example)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type 1..1 Extension Type of recorded sex or gender.

Example sex-assigned-at-birth: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.url 1..1 uri "type"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.url 1..1 uri "effectivePeriod"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.url 1..1 uri "acquisitionDate"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.value[x] 1..1 dateTime Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.url 1..1 uri "source"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x] 1..1 Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x].valueCodeableConcept CodeableConcept
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x].valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.url 1..1 uri "sourceDocument"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x] 1..1 Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x].valueCodeableConcept CodeableConcept
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x].valueReference Reference(DocumentReference)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.url 1..1 uri "sourceField"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.value[x] 1..1 string Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.url 1..1 uri "jurisdiction"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment 0..1 Extension Context or source information about the recorded sex or gender
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.url 1..1 uri "comment"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.value[x] 1..1 string Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.url 1..1 uri "genderElementQualifier"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.value[x] 1..1 boolean Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
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.gender This element is included in summaries. 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..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.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.extension:recordedSexOrGender.​extension:value.value[x] Base example AdministrativeGender 📦4.0.1 FHIR Std.
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.4
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.4
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()
recordedSexOrGender-or-gender error Patient If recordedSexOrGender extension is not present, gender shall be valued. extension.where(url = 'http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').exists() or gender.exists()

Differential View

This structure is derived from PatientEu

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientEu Information about an individual receiving health care services
Constraints: recordedSexOrGender-or-gender
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:recordedSexOrGender.extension 2..* Extension Extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value 1..1 Extension The recorded sex or gender property for the individual
Example sex-assigned-at-birth: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type 1..1 Extension Type of recorded sex or gender.
Example sex-assigned-at-birth: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
Patient.gender 0..1 code Administrative gender
Patient.birthDate 1..1 date The date of birth for the individual

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
recordedSexOrGender-or-gender error Patient If recordedSexOrGender extension is not present, gender shall be valued. extension.where(url = 'http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').exists() or gender.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientEu Information about an individual receiving health care services
Constraints: recordedSexOrGender-or-gender
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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id 0..1 id Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 AddressEu The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Value of extension
Patient.Slices for extension.extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Patient.Slices for extension.extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
Patient.Slices for extension.extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
Patient.Slices for extension.extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
Patient.Slices for extension.extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.Slices for extension.extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Patient.Slices for extension.extension:recordedSexOrGender.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value 1..1 Extension The recorded sex or gender property for the individual

Example sex-assigned-at-birth: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.url 1..1 uri "value"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:value.value[x] 1..1 CodeableConcept Value of extension
Binding: AdministrativeGender (example)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type 1..1 Extension Type of recorded sex or gender.

Example sex-assigned-at-birth: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.url 1..1 uri "type"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:type.value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.url 1..1 uri "effectivePeriod"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:effectivePeriod.value[x] 0..1 Period Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.url 1..1 uri "acquisitionDate"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:acquisitionDate.value[x] 1..1 dateTime Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.url 1..1 uri "source"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x] 1..1 Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x].valueCodeableConcept CodeableConcept
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:source.value[x].valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.url 1..1 uri "sourceDocument"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x] 1..1 Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x].valueCodeableConcept CodeableConcept
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceDocument.value[x].valueReference Reference(DocumentReference)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.url 1..1 uri "sourceField"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:sourceField.value[x] 1..1 string Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.url 1..1 uri "jurisdiction"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:jurisdiction.value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment 0..1 Extension Context or source information about the recorded sex or gender
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.url 1..1 uri "comment"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:comment.value[x] 1..1 string Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.url 1..1 uri "genderElementQualifier"
Patient.Slices for extension.extension:recordedSexOrGender.Slices for extension.extension:genderElementQualifier.value[x] 1..1 boolean Value of extension
Patient.Slices for extension.extension:recordedSexOrGender.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
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 Patient identifiers
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.name This element is included in summaries. 0..* HumanName A name associated with the patient
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name.
Patient.name.family This element is included in summaries. 0..1 string Family name.
Example spanish: Valero Iglesias
Patient.name.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.name.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.name.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.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the patient
Patient.gender This element is included in summaries. 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 1..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..* AddressEu The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital status
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 Contact 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 Contact name
Patient.contact.telecom 0..* ContactPoint Contact details for the person
Patient.contact.address 0..1 AddressEu The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Contact person address
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 Communication language
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.extension:recordedSexOrGender.​extension:value.value[x] Base example AdministrativeGender 📦4.0.1 FHIR Std.
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.4
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.4
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()
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()
recordedSexOrGender-or-gender error Patient If recordedSexOrGender extension is not present, gender shall be valued. extension.where(url = 'http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').exists() or gender.exists()

This structure is derived from PatientEu

Summary

Mandatory: 1 element(1 nested mandatory element)

Extensions

This structure refers to these extensions:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron