HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR)

This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

SD.2 StructureDefinition-ecr-patient

This Patient profile represents an eCR Patient. It is based on the US Core Patient profile with further restrictions to allow masking of some data elements and the addition of the patient-genderIdentity extension.

SD.2.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-patient

Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.

This profile builds on USCorePatientProfile

Text Summary
Differential Table
Snapshot Table
All

Summary

Mandatory: 5 elements (11 nested mandatory elements)
Must-Support: 36 elements
Fixed Value: 6 elements

Extensions

This structure refers to these extensions:

Name	Flags	Card.	Type	Description & Constraints
Patient	S	0..*	USCorePatientProfile	eCR Patient
us-core-race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
us-core-birthsex	S	0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required)
patient-genderIdentity	S	0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example)
identifier	S	1..*	Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
name		1..*	HumanName
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
telecom	S	1..*	ContactPoint
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
gender	S	1..1	code
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
birthDate	S	1..1	date
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
deceased[x]		0..1	boolean, dateTime
address	S	1..*	Address
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
contact	S	0..*	BackboneElement
relationship	S	1..1	CodeableConcept
name	S	0..1	HumanName
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
valueCode:valueCode	S	1..1	code	Required Pattern: masked
telecom	S	0..*	ContactPoint
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
valueCode:valueCode	S	1..1	code	Required Pattern: masked
address	S	0..1	Address
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
valueCode:valueCode	S	1..1	code	Required Pattern: masked
communication	S	0..*	BackboneElement
language	S	1..1	CodeableConcept
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
valueCode:valueCode	S	1..1	code	Required Pattern: masked
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient	SI	0..*	USCorePatientProfile	eCR Patient
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) Max Binding: AllLanguages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
us-core-race	SI	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	SI	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
us-core-birthsex	SI	0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required)
patient-genderIdentity	S	0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣI	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!Σ	0..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	1..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
system	SΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	SΣ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
value		0..1	string	Primitive value for code
birthDate	SΣ	1..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible)
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T04:00:00+00:00","end":"2010-07-01T04:00:00+00:00"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	SI	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
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	S	1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible)
name	S	0..1	HumanName	A name associated with the contact person
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!ΣI	0..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	ΣI	0..1	string	Text representation of the full name
family	ΣI	0..1	string	Family name (often called 'Surname')
given	ΣI	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	ΣI	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	ΣI	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	ΣI	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
system	ΣI	0..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	ΣI	0..1	string	The actual contact point details
use	?!ΣI	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	ΣI	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣI	0..1	Period	Time period when the contact point was/is in use
address	S	0..1	Address	Address for the contact person
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!ΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	ΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	ΣI	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	ΣI	0..1	string	Name of city, town etc. Example General: Erewhon
district	ΣI	0..1	string	District name (aka county) Example General: Madison
state	ΣI	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	ΣI	0..1	string	Postal code for area Example General: 9132
country	ΣI	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	ΣI	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
gender		0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
organization	I	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	SI	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	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) Max Binding: Language codes with language and optionally a region modifier
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
coding	ΣI	0..*	Coding	Code defined by a terminology system
text	ΣI	0..1	string	Plain text representation of the concept
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	?!ΣI	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)
Documentation for this format

Summary

Mandatory: 5 elements (11 nested mandatory elements)
Must-Support: 36 elements
Fixed Value: 6 elements

Extensions

This structure refers to these extensions:

Differential View

Name	Flags	Card.	Type	Description & Constraints
Patient	S	0..*	USCorePatientProfile	eCR Patient
us-core-race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
us-core-birthsex	S	0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required)
patient-genderIdentity	S	0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example)
identifier	S	1..*	Identifier
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
name		1..*	HumanName
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
telecom	S	1..*	ContactPoint
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
gender	S	1..1	code
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
birthDate	S	1..1	date
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
deceased[x]		0..1	boolean, dateTime
address	S	1..*	Address
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
valueCode:valueCode	S	1..1	code	Required Pattern: masked
contact	S	0..*	BackboneElement
relationship	S	1..1	CodeableConcept
name	S	0..1	HumanName
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
valueCode:valueCode	S	1..1	code	Required Pattern: masked
telecom	S	0..*	ContactPoint
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
valueCode:valueCode	S	1..1	code	Required Pattern: masked
address	S	0..1	Address
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
valueCode:valueCode	S	1..1	code	Required Pattern: masked
communication	S	0..*	BackboneElement
language	S	1..1	CodeableConcept
extension		0..*	Extension	Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
valueCode:valueCode	S	1..1	code	Required Pattern: masked
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	SI	0..*	USCorePatientProfile	eCR Patient
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) Max Binding: AllLanguages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
us-core-race	SI	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	SI	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
us-core-birthsex	SI	0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required)
patient-genderIdentity	S	0..1	CodeableConcept	The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣI	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!Σ	0..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	1..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
system	SΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	SΣ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
value		0..1	string	Primitive value for code
birthDate	SΣ	1..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	1..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	S	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible)
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T04:00:00+00:00","end":"2010-07-01T04:00:00+00:00"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	SI	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
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	S	1..1	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible)
name	S	0..1	HumanName	A name associated with the contact person
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!ΣI	0..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	ΣI	0..1	string	Text representation of the full name
family	ΣI	0..1	string	Family name (often called 'Surname')
given	ΣI	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	ΣI	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	ΣI	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	ΣI	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	A contact detail for the person
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
system	ΣI	0..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	ΣI	0..1	string	The actual contact point details
use	?!ΣI	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	ΣI	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣI	0..1	Period	Time period when the contact point was/is in use
address	S	0..1	Address	Address for the contact person
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
use	?!ΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	ΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	ΣI	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	ΣI	0..1	string	Name of city, town etc. Example General: Erewhon
district	ΣI	0..1	string	District name (aka county) Example General: Madison
state	ΣI	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	ΣI	0..1	string	Postal code for area Example General: 9132
country	ΣI	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	ΣI	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
gender		0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
organization	I	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	SI	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	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) Max Binding: Language codes with language and optionally a region modifier
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
data-absent-reason	SI	0..1	code	unknown \| asked \| temp \| notasked \| masked \| unsupported \| astext \| error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]	I	1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this Binding: DataAbsentReason (required)
value[x]:valueCode	SI	1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: masked
coding	ΣI	0..*	Coding	Code defined by a terminology system
text	ΣI	0..1	string	Plain text representation of the concept
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	?!ΣI	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)
Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron