Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvIps	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
nomePai		0..1	string	Nome do Pai do Paciente URL: https://fhir.omnisaude.co/r4/core/StructureDefinition/nome-pai-paciente ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
nomeMae		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
nacionalidade		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
corEtnia		0..1	(Complex)	Raça/Cor e Etnia URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRacaCorEtnia-1.0 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	1..*	Identifier	An identifier for this patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SΣC	1..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	SΣ	1..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
family	SΣ	0..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	Σ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣC	0..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
Slices for line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:$this.id ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:bairro	Σ	0..1	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: bairro
line:logradouro	Σ	0..1	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: logradouro
line:tipoLogradouro	Σ	0..1	string	Street name, number, direction & P.O. Box etc. Binding: Tipo de Logradouro (extensible) ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: tipoLogradouro
line:numero	Σ	0..1	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: numero
line:complemento	Σ	0..1	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: complemento
city	Σ	0..1	string	Name of city, town etc. Binding: Município (extensible) ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Unidade Federativa (extensible) ele-1: All FHIR elements must have a @value or children
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-3 (required) ele-1: All FHIR elements must have a @value or children
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.line:tipoLogradouro	extensible	TipoLogradouro (a valid code from Tipo de Logradouro) https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro from this IG
Patient.address.city	extensible	Município http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Patient.address.state	extensible	Unidade Federativa http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Patient.address.country	required	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists()
pat-cnt-2or3-char	warning	Patient.address	The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Name	Flags	Card.	Type	Description & Constraints
Patient			PatientUvIps
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nomePai		0..1	string	Nome do Pai do Paciente URL: https://fhir.omnisaude.co/r4/core/StructureDefinition/nome-pai-paciente
nomeMae		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
nacionalidade		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
corEtnia		0..1	(Complex)	Raça/Cor e Etnia URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRacaCorEtnia-1.0
identifier		1..*	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
name
text		1..1	string	Text representation of the full name
telecom
system		1..1	code	phone | fax | email | pager | url | sms | other
value		1..1	string	The actual contact point details
gender		1..1	code	male | female | other | unknown
address
Slices for line		0..*	string	Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:$this.id
line:bairro		0..1	string	Street name, number, direction & P.O. Box etc.
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: bairro
line:logradouro		0..1	string	Street name, number, direction & P.O. Box etc.
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: logradouro
line:tipoLogradouro		0..1	string	Street name, number, direction & P.O. Box etc. Binding: Tipo de Logradouro (extensible)
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: tipoLogradouro
line:numero		0..1	string	Street name, number, direction & P.O. Box etc.
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: numero
line:complemento		0..1	string	Street name, number, direction & P.O. Box etc.
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: complemento
city		0..1	string	Name of city, town etc. Binding: Município (extensible)
state		0..1	string	Sub-unit of country (abbreviations ok) Binding: Unidade Federativa (extensible)
country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-3 (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.address.line:tipoLogradouro	extensible	TipoLogradouro (a valid code from Tipo de Logradouro) https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro from this IG
Patient.address.city	extensible	Município http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Patient.address.state	extensible	Unidade Federativa http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Patient.address.country	required	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvIps	Information about an individual or animal receiving health care services
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nomePai		0..1	string	Nome do Pai do Paciente URL: https://fhir.omnisaude.co/r4/core/StructureDefinition/nome-pai-paciente
nomeMae		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
nacionalidade		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
corEtnia		0..1	(Complex)	Raça/Cor e Etnia URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRacaCorEtnia-1.0
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	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	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): Use of contact point.
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): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣC	0..*	Address	An address for the individual pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Slices for line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:$this.id This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:bairro	Σ	0..1	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
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: bairro
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
line:logradouro	Σ	0..1	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
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: logradouro
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
line:tipoLogradouro	Σ	0..1	string	Street name, number, direction & P.O. Box etc. Binding: Tipo de Logradouro (extensible) This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: tipoLogradouro
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
line:numero	Σ	0..1	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
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: numero
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
line:complemento	Σ	0..1	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
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: complemento
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Binding: Município (extensible) Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Unidade Federativa (extensible)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-3 (required)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.line:tipoLogradouro	extensible	TipoLogradouro (a valid code from Tipo de Logradouro) https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro from this IG
Patient.address.city	extensible	Município http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Patient.address.state	extensible	Unidade Federativa http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Patient.address.country	required	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists()
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()
pat-cnt-2or3-char	warning	Patient.address	The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Summary

Mandatory: 5 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

• https://fhir.omnisaude.co/r4/core/StructureDefinition/nome-pai-paciente
• http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
• http://hl7.org/fhir/StructureDefinition/patient-nationality
• http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRacaCorEtnia-1.0

Slices

This structure defines the following Slices:

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

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvIps	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
nomePai		0..1	string	Nome do Pai do Paciente URL: https://fhir.omnisaude.co/r4/core/StructureDefinition/nome-pai-paciente ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
nomeMae		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
nacionalidade		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
corEtnia		0..1	(Complex)	Raça/Cor e Etnia URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRacaCorEtnia-1.0 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	1..*	Identifier	An identifier for this patient ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	SΣC	1..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	SΣ	1..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
family	SΣ	0..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	Σ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣC	0..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
Slices for line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:$this.id ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:bairro	Σ	0..1	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: bairro
line:logradouro	Σ	0..1	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: logradouro
line:tipoLogradouro	Σ	0..1	string	Street name, number, direction & P.O. Box etc. Binding: Tipo de Logradouro (extensible) ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: tipoLogradouro
line:numero	Σ	0..1	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: numero
line:complemento	Σ	0..1	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: complemento
city	Σ	0..1	string	Name of city, town etc. Binding: Município (extensible) ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Unidade Federativa (extensible) ele-1: All FHIR elements must have a @value or children
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-3 (required) ele-1: All FHIR elements must have a @value or children
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.line:tipoLogradouro	extensible	TipoLogradouro (a valid code from Tipo de Logradouro) https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro from this IG
Patient.address.city	extensible	Município http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Patient.address.state	extensible	Unidade Federativa http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Patient.address.country	required	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists()
pat-cnt-2or3-char	warning	Patient.address	The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Name	Flags	Card.	Type	Description & Constraints
Patient			PatientUvIps
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nomePai		0..1	string	Nome do Pai do Paciente URL: https://fhir.omnisaude.co/r4/core/StructureDefinition/nome-pai-paciente
nomeMae		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
nacionalidade		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
corEtnia		0..1	(Complex)	Raça/Cor e Etnia URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRacaCorEtnia-1.0
identifier		1..*	Identifier	An identifier for this patient
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
name
text		1..1	string	Text representation of the full name
telecom
system		1..1	code	phone | fax | email | pager | url | sms | other
value		1..1	string	The actual contact point details
gender		1..1	code	male | female | other | unknown
address
Slices for line		0..*	string	Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:$this.id
line:bairro		0..1	string	Street name, number, direction & P.O. Box etc.
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: bairro
line:logradouro		0..1	string	Street name, number, direction & P.O. Box etc.
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: logradouro
line:tipoLogradouro		0..1	string	Street name, number, direction & P.O. Box etc. Binding: Tipo de Logradouro (extensible)
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: tipoLogradouro
line:numero		0..1	string	Street name, number, direction & P.O. Box etc.
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: numero
line:complemento		0..1	string	Street name, number, direction & P.O. Box etc.
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: complemento
city		0..1	string	Name of city, town etc. Binding: Município (extensible)
state		0..1	string	Sub-unit of country (abbreviations ok) Binding: Unidade Federativa (extensible)
country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-3 (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.address.line:tipoLogradouro	extensible	TipoLogradouro (a valid code from Tipo de Logradouro) https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro from this IG
Patient.address.city	extensible	Município http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Patient.address.state	extensible	Unidade Federativa http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Patient.address.country	required	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	PatientUvIps	Information about an individual or animal receiving health care services
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nomePai		0..1	string	Nome do Pai do Paciente URL: https://fhir.omnisaude.co/r4/core/StructureDefinition/nome-pai-paciente
nomeMae		0..1	string	Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
nacionalidade		0..*	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
corEtnia		0..1	(Complex)	Raça/Cor e Etnia URL: http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRacaCorEtnia-1.0
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	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	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): Use of contact point.
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): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣC	0..*	Address	An address for the individual pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Slices for line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:$this.id This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
line:bairro	Σ	0..1	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
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: bairro
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
line:logradouro	Σ	0..1	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
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: logradouro
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
line:tipoLogradouro	Σ	0..1	string	Street name, number, direction & P.O. Box etc. Binding: Tipo de Logradouro (extensible) This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: tipoLogradouro
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
line:numero	Σ	0..1	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
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: numero
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
line:complemento	Σ	0..1	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
id		0..1	string	xml:id (or equivalent in JSON) Required Pattern: complemento
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Binding: Município (extensible) Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Unidade Federativa (extensible)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Iso3166-1-3 (required)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.line:tipoLogradouro	extensible	TipoLogradouro (a valid code from Tipo de Logradouro) https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro from this IG
Patient.address.city	extensible	Município http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Patient.address.state	extensible	Unidade Federativa http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Patient.address.country	required	Iso3166-1-3 http://hl7.org/fhir/ValueSet/iso3166-1-3 from the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists()
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()
pat-cnt-2or3-char	warning	Patient.address	The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. : country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Summary

Mandatory: 5 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

• https://fhir.omnisaude.co/r4/core/StructureDefinition/nome-pai-paciente
• http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
• http://hl7.org/fhir/StructureDefinition/patient-nationality
• http://www.saude.gov.br/fhir/r4/StructureDefinition/BRRacaCorEtnia-1.0

Slices

This structure defines the following Slices:

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