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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Patient (CCM)

This profile defines how to represent Patient in FHIR for the purpose of the IDEA4RC project.

Usages:

• Refer to this Profile: Observation: Comorbidities

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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientEu	Information about an individual receiving health care services Constraints: recordedSexOrGender-or-gender
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	AddressEu	Value of extension
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:gender-identity		0..*	(Complex)	Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:pronouns		0..*	(Complex)	Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
extension:recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:value		1..1	Extension	Extension Example sex-assigned-at-birth: {}
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"value"
value[x]		1..1	CodeableConcept	Value of extension Binding: AdministrativeGender (example) Example null: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
extension:type		1..1	Extension	Extension Example sex-assigned-at-birth: {}
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"type"
value[x]		1..1	CodeableConcept	Value of extension Binding: Recorded Sex Or Gender Type (example) Example null: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
extension:effectivePeriod		0..1	Extension	When the recorded sex or gender value applies
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"effectivePeriod"
extension:acquisitionDate		0..1	Extension	When the sex or gender value was recorded.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"acquisitionDate"
value[x]		1..1	dateTime	Value of extension
extension:source		0..1	Extension	The source of the Recorded Sex or Gender value.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"source"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(Organization | Device | RelatedPerson | Practitioner)
extension:sourceDocument		0..1	Extension	The document the sex or gender property was acquired from.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"sourceDocument"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(DocumentReference)
extension:sourceField		0..1	Extension	The name of the field within the source document where this sex or gender property is initially recorded.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"sourceField"
value[x]		1..1	string	Value of extension
extension:jurisdiction		0..1	Extension	Who issued the document where the sex or gender was aquired
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"jurisdiction"
value[x]		1..1	CodeableConcept	Value of extension Binding: Jurisdiction ValueSet (extensible)
extension:comment		0..1	Extension	Context or source information about the recorded sex or gender
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"comment"
value[x]		1..1	string	Value of extension
extension:genderElementQualifier		0..1	Extension	Whether this recorded sex or gender value qualifies the .gender element.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"genderElementQualifier"
value[x]		1..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
gender	Σ	0..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the patient
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
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.0
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.0
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientEu	Information about an individual receiving health care services Constraints: recordedSexOrGender-or-gender
Slices for extension				Content/Rules for all slices
extension:recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension		2..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:value		1..1	Extension	Extension Example sex-assigned-at-birth: {}
value[x]		1..1	CodeableConcept	Value of extension Example null: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
extension:type		1..1	Extension	Extension Example sex-assigned-at-birth: {}
value[x]		1..1	CodeableConcept	Value of extension Example null: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
gender		0..1	code	Administrative gender
birthDate		1..1	date	The date of birth for the patient
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()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientEu	Information about an individual receiving health care services Constraints: recordedSexOrGender-or-gender
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	AddressEu	Value of extension
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:gender-identity		0..*	(Complex)	Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:pronouns		0..*	(Complex)	Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
extension:recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
id		0..1	id	Unique id for inter-element referencing
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:value		1..1	Extension	Extension Example sex-assigned-at-birth: {}
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"value"
value[x]		1..1	CodeableConcept	Value of extension Binding: AdministrativeGender (example) Example null: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
extension:type		1..1	Extension	Extension Example sex-assigned-at-birth: {}
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"type"
value[x]		1..1	CodeableConcept	Value of extension Binding: Recorded Sex Or Gender Type (example) Example null: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
extension:effectivePeriod		0..1	Extension	When the recorded sex or gender value applies
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"effectivePeriod"
value[x]		0..1	Period	Value of extension
extension:acquisitionDate		0..1	Extension	When the sex or gender value was recorded.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"acquisitionDate"
value[x]		1..1	dateTime	Value of extension
extension:source		0..1	Extension	The source of the Recorded Sex or Gender value.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"source"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(Organization | Device | RelatedPerson | Practitioner)
extension:sourceDocument		0..1	Extension	The document the sex or gender property was acquired from.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"sourceDocument"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(DocumentReference)
extension:sourceField		0..1	Extension	The name of the field within the source document where this sex or gender property is initially recorded.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"sourceField"
value[x]		1..1	string	Value of extension
extension:jurisdiction		0..1	Extension	Who issued the document where the sex or gender was aquired
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"jurisdiction"
value[x]		1..1	CodeableConcept	Value of extension Binding: Jurisdiction ValueSet (extensible)
extension:comment		0..1	Extension	Context or source information about the recorded sex or gender
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"comment"
value[x]		1..1	string	Value of extension
extension:genderElementQualifier		0..1	Extension	Whether this recorded sex or gender value qualifies the .gender element.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"genderElementQualifier"
value[x]		1..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Patient identifiers
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name.
family	Σ	0..1	string	Family name. Example spanish: Valero Iglesias
given	Σ	0..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the patient
gender	Σ	0..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the patient
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	AddressEu	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital status Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	Contact relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	Contact name
telecom		0..*	ContactPoint	Contact details for the person
address		0..1	AddressEu	Contact person address
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	Communication language Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider.
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
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.0
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.0
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:

• http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientEu	Information about an individual receiving health care services Constraints: recordedSexOrGender-or-gender
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	AddressEu	Value of extension
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:gender-identity		0..*	(Complex)	Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:pronouns		0..*	(Complex)	Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
extension:recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:value		1..1	Extension	Extension Example sex-assigned-at-birth: {}
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"value"
value[x]		1..1	CodeableConcept	Value of extension Binding: AdministrativeGender (example) Example null: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
extension:type		1..1	Extension	Extension Example sex-assigned-at-birth: {}
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"type"
value[x]		1..1	CodeableConcept	Value of extension Binding: Recorded Sex Or Gender Type (example) Example null: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
extension:effectivePeriod		0..1	Extension	When the recorded sex or gender value applies
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"effectivePeriod"
extension:acquisitionDate		0..1	Extension	When the sex or gender value was recorded.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"acquisitionDate"
value[x]		1..1	dateTime	Value of extension
extension:source		0..1	Extension	The source of the Recorded Sex or Gender value.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"source"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(Organization | Device | RelatedPerson | Practitioner)
extension:sourceDocument		0..1	Extension	The document the sex or gender property was acquired from.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"sourceDocument"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(DocumentReference)
extension:sourceField		0..1	Extension	The name of the field within the source document where this sex or gender property is initially recorded.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"sourceField"
value[x]		1..1	string	Value of extension
extension:jurisdiction		0..1	Extension	Who issued the document where the sex or gender was aquired
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"jurisdiction"
value[x]		1..1	CodeableConcept	Value of extension Binding: Jurisdiction ValueSet (extensible)
extension:comment		0..1	Extension	Context or source information about the recorded sex or gender
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"comment"
value[x]		1..1	string	Value of extension
extension:genderElementQualifier		0..1	Extension	Whether this recorded sex or gender value qualifies the .gender element.
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"genderElementQualifier"
value[x]		1..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
gender	Σ	0..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the patient
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
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.0
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.0
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientEu	Information about an individual receiving health care services Constraints: recordedSexOrGender-or-gender
Slices for extension				Content/Rules for all slices
extension:recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension		2..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:value		1..1	Extension	Extension Example sex-assigned-at-birth: {}
value[x]		1..1	CodeableConcept	Value of extension Example null: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
extension:type		1..1	Extension	Extension Example sex-assigned-at-birth: {}
value[x]		1..1	CodeableConcept	Value of extension Example null: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
gender		0..1	code	Administrative gender
birthDate		1..1	date	The date of birth for the patient
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientEu	Information about an individual receiving health care services Constraints: recordedSexOrGender-or-gender
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	AddressEu	Value of extension
extension:sex-for-clinical-use		0..*	(Complex)	Sex for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
extension:gender-identity		0..*	(Complex)	Gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:pronouns		0..*	(Complex)	Pronouns URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:patient-citizenship		0..*	(Complex)	Citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
extension:patient-nationality		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:birthTime		0..1	dateTime	Birth time URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
extension:recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
id		0..1	id	Unique id for inter-element referencing
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:value		1..1	Extension	Extension Example sex-assigned-at-birth: {}
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"value"
value[x]		1..1	CodeableConcept	Value of extension Binding: AdministrativeGender (example) Example null: {"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"female"}]}
extension:type		1..1	Extension	Extension Example sex-assigned-at-birth: {}
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"type"
value[x]		1..1	CodeableConcept	Value of extension Binding: Recorded Sex Or Gender Type (example) Example null: {"coding":[{"system":"http://loinc.org","code":"76689-9","display":"Sex assigned at birth"}]}
extension:effectivePeriod		0..1	Extension	When the recorded sex or gender value applies
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"effectivePeriod"
value[x]		0..1	Period	Value of extension
extension:acquisitionDate		0..1	Extension	When the sex or gender value was recorded.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"acquisitionDate"
value[x]		1..1	dateTime	Value of extension
extension:source		0..1	Extension	The source of the Recorded Sex or Gender value.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"source"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(Organization | Device | RelatedPerson | Practitioner)
extension:sourceDocument		0..1	Extension	The document the sex or gender property was acquired from.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"sourceDocument"
value[x]		1..1		Value of extension
valueCodeableConcept			CodeableConcept
valueReference			Reference(DocumentReference)
extension:sourceField		0..1	Extension	The name of the field within the source document where this sex or gender property is initially recorded.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"sourceField"
value[x]		1..1	string	Value of extension
extension:jurisdiction		0..1	Extension	Who issued the document where the sex or gender was aquired
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"jurisdiction"
value[x]		1..1	CodeableConcept	Value of extension Binding: Jurisdiction ValueSet (extensible)
extension:comment		0..1	Extension	Context or source information about the recorded sex or gender
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"comment"
value[x]		1..1	string	Value of extension
extension:genderElementQualifier		0..1	Extension	Whether this recorded sex or gender value qualifies the .gender element.
id		0..1	id	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"genderElementQualifier"
value[x]		1..1	boolean	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Patient identifiers
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name.
family	Σ	0..1	string	Family name. Example spanish: Valero Iglesias
given	Σ	0..*	string	Given names. Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the patient
gender	Σ	0..1	code	Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the patient
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	AddressEu	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital status Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	Contact relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	Contact name
telecom		0..*	ContactPoint	Contact details for the person
address		0..1	AddressEu	Contact person address
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	Communication language Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider.
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
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.0
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x]	Base	extensible	Jurisdiction ValueSet	📦1.0.0	THO v7.0
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:

• http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender

​Other representations of profile: CSV, Excel, Schematron