HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
1.0.0 - STU1 International flag

HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/patient-admin-ig/ and changes regularly. See the Directory of published versions

Resource Profile: PTPatient

Official URL: http://example.com/fhir/example/StructureDefinition/Patient-Pt Version: 1.0.0
Active as of 2025-09-26 Computable Name: PTPatient

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:occupation S 0..* (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonOccupation-Pt
.... extension:patient-record-type 0..* boolean Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonRecordType-Pt
.... extension:patient-enrollment-category-primarycare 0..* CodeableConcept Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientEnrollmentCategoryPrimarycare-Pt
.... extension:nationality S 0..* CodeableConcept Extension
URL: http://example.com/fhir/example/StructureDefinition/Nationality
.... extension:birthplace 0..1 (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonBirthplace-Pt
... Slices for identifier Σ 0..* Identifier An identifier for this patient
Slice: Unordered, Closed by type:type
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:residentCardNumber SΣ 0..* Identifier Número do Título de Residência
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:citizenshipCardNumber SΣ 0..* Identifier Número de Identificação Civil
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:taxIdNumber SΣ 0..* Identifier Número de Identificação Fiscal
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:socialSecurityNumber SΣ 0..* Identifier Número de Identificação da Segurança Social
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:healthCardNumber SΣ 0..* Identifier Número Nacional do Utente
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:passportNumber SΣ 0..* Identifier Número do Passaporte
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:patientInternalIdentifier SΣ 0..* Identifier Número Interno do Utente
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:militaryIDNumber SΣ 0..* Identifier Número da Cédula Militar
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:medicalRecordNumber SΣ 0..* Identifier Numero de processo Clinico
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:familyRecordNumber SΣ 0..* Identifier Numero de processo clinico familiar
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:birthRegistryNumber SΣ 0..* Identifier Cédula de Nascimento
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..1 HumanName A name associated with the patient
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:addressType S 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
..... extension:municipality S 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
..... extension:county S 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
..... extension:parish S 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
..... extension:nuts S 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
... contact SC 0..1 BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
.... Slices for extension Content/Rules for all slices
..... extension:patient-primary-care-period S 0..* Period Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientPrimaryCarePeriod-Pt
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:residentCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:citizenshipCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:taxIdNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:socialSecurityNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:healthCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:passportNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:patientInternalIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:militaryIDNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:medicalRecordNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:familyRecordNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:birthRegistryNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.3.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id S 1..1 id Logical id of this artifact
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:occupation S 0..* (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonOccupation-Pt
.... extension:patient-record-type 0..* boolean Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonRecordType-Pt
.... extension:patient-enrollment-category-primarycare 0..* CodeableConcept Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientEnrollmentCategoryPrimarycare-Pt
.... extension:nationality S 0..* CodeableConcept Extension
URL: http://example.com/fhir/example/StructureDefinition/Nationality
.... extension:birthplace 0..1 (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonBirthplace-Pt
... Slices for identifier 0..* Identifier An identifier for this patient
Slice: Unordered, Closed by type:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..0
..... type
...... id 0..0
...... extension 0..0
...... coding 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)
.... identifier:residentCardNumber S 0..* Identifier Número do Título de Residência
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
....... display 1..1 string Representation defined by the system
Fixed Value: Número do Título de Residência
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número do Título de Residência
.... identifier:citizenshipCardNumber S 0..* Identifier Número de Identificação Civil
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CZ
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Identificação Civil
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação Civil
.... identifier:taxIdNumber S 0..* Identifier Número de Identificação Fiscal
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Identificação Fiscal
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação Fiscal
.... identifier:socialSecurityNumber S 0..* Identifier Número de Identificação da Segurança Social
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Segurança Social
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação da Segurança Social
.... identifier:healthCardNumber S 0..* Identifier Número Nacional do Utente
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: HC
....... display 1..1 string Representation defined by the system
Fixed Value: Número Nacional do Utente
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número Nacional do Utente
.... identifier:passportNumber S 0..* Identifier Número do Passaporte
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Passaporte
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número do Passaporte
.... identifier:patientInternalIdentifier S 0..* Identifier Número Interno do Utente
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Número Interno do Utente
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número Interno do Utente
.... identifier:militaryIDNumber S 0..* Identifier Número da Cédula Militar
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MI
....... display 1..1 string Representation defined by the system
Fixed Value: Número da Cédula Militar
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número da Cédula Militar
.... identifier:medicalRecordNumber S 0..* Identifier Numero de processo Clinico
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Numero de processo Clinico
...... text 0..1 string Plain text representation of the concept
Required Pattern: Numero de processo Clinico
.... identifier:familyRecordNumber S 0..* Identifier Numero de processo clinico familiar
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Numero de processo clinico familiar
...... text 0..1 string Plain text representation of the concept
Required Pattern: Numero de processo clinico familiar
.... identifier:birthRegistryNumber S 0..* Identifier Cédula de Nascimento
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BR
....... display 1..1 string Representation defined by the system
Fixed Value: Cédula de Nascimento
...... text 0..1 string Plain text representation of the concept
Required Pattern: Cédula de Nascimento
... telecom S 0..* ContactPoint A contact detail for the individual
... address
.... Slices for extension Content/Rules for all slices
..... extension:addressType S 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
..... extension:municipality S 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
..... extension:county S 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
..... extension:parish S 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
..... extension:nuts S 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
... contact S 0..1 BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
.... address
..... Slices for extension Content/Rules for all slices
...... extension:addressType 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
...... extension:municipality 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
...... extension:county 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
...... extension:parish 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
...... extension:nuts 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
... generalPractitioner
.... Slices for extension Content/Rules for all slices
..... extension:patient-primary-care-period S 0..* Period Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientPrimaryCarePeriod-Pt

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.identifier.type.codingextensibleVS_PatientIdentifierType
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id SΣ 1..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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:occupation S 0..* (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonOccupation-Pt
.... extension:patient-record-type 0..* boolean Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonRecordType-Pt
.... extension:patient-enrollment-category-primarycare 0..* CodeableConcept Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientEnrollmentCategoryPrimarycare-Pt
.... extension:nationality S 0..* CodeableConcept Extension
URL: http://example.com/fhir/example/StructureDefinition/Nationality
.... extension:birthplace 0..1 (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonBirthplace-Pt
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier An identifier for this patient
Slice: Unordered, Closed by type:type
.... identifier:All Slices Content/Rules for all slices
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:residentCardNumber SΣ 0..* Identifier Número do Título de Residência
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
....... display 1..1 string Representation defined by the system
Fixed Value: Número do Título de Residência
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número do Título de Residência
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:citizenshipCardNumber SΣ 0..* Identifier Número de Identificação Civil
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CZ
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Identificação Civil
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação Civil
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:taxIdNumber SΣ 0..* Identifier Número de Identificação Fiscal
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Identificação Fiscal
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação Fiscal
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:socialSecurityNumber SΣ 0..* Identifier Número de Identificação da Segurança Social
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Segurança Social
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação da Segurança Social
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:healthCardNumber SΣ 0..* Identifier Número Nacional do Utente
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: HC
....... display 1..1 string Representation defined by the system
Fixed Value: Número Nacional do Utente
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número Nacional do Utente
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:passportNumber SΣ 0..* Identifier Número do Passaporte
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Passaporte
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número do Passaporte
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:patientInternalIdentifier SΣ 0..* Identifier Número Interno do Utente
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Número Interno do Utente
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número Interno do Utente
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:militaryIDNumber SΣ 0..* Identifier Número da Cédula Militar
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MI
....... display 1..1 string Representation defined by the system
Fixed Value: Número da Cédula Militar
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número da Cédula Militar
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:medicalRecordNumber SΣ 0..* Identifier Numero de processo Clinico
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Numero de processo Clinico
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Numero de processo Clinico
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:familyRecordNumber SΣ 0..* Identifier Numero de processo clinico familiar
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Numero de processo clinico familiar
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Numero de processo clinico familiar
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:birthRegistryNumber SΣ 0..* Identifier Cédula de Nascimento
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BR
....... display 1..1 string Representation defined by the system
Fixed Value: Cédula de Nascimento
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Cédula de Nascimento
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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Σ 1..1 HumanName A name associated with the patient
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..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 Σ 0..* Address An address for the individual
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:addressType S 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
..... extension:municipality S 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
..... extension:county S 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
..... extension:parish S 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
..... extension:nuts S 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
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
.... line Σ 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 Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... 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)
.... 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 SC 0..1 BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:addressType 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
...... extension:municipality 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
...... extension:county 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
...... extension:parish 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
...... extension:nuts 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
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
..... line Σ 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 Σ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state Σ 0..1 string Sub-unit of country (abbreviations ok)
..... 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)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... 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): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:patient-primary-care-period S 0..* Period Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientPrimaryCarePeriod-Pt
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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.

doco Documentation for this format

Terminology Bindings

Constraints

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.3.0
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier.type.codingextensibleVS_PatientIdentifierType
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:residentCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:residentCardNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:residentCardNumber.type.codingextensiblePattern Value: PRC("Número do Título de Residência")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:citizenshipCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:citizenshipCardNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:citizenshipCardNumber.type.codingextensiblePattern Value: CZ("Número de Identificação Civil")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:taxIdNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:taxIdNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:taxIdNumber.type.codingextensiblePattern Value: TAX("Número de Identificação Fiscal")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:socialSecurityNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:socialSecurityNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:socialSecurityNumber.type.codingextensiblePattern Value: SS("Número de Segurança Social")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:healthCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:healthCardNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:healthCardNumber.type.codingextensiblePattern Value: HC("Número Nacional do Utente")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:passportNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:passportNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:passportNumber.type.codingextensiblePattern Value: PPN("Número de Passaporte")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:patientInternalIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:patientInternalIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:patientInternalIdentifier.type.codingextensiblePattern Value: PI("Número Interno do Utente")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:militaryIDNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:militaryIDNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:militaryIDNumber.type.codingextensiblePattern Value: MI("Número da Cédula Militar")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:medicalRecordNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:medicalRecordNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:medicalRecordNumber.type.codingextensiblePattern Value: MR("Numero de processo Clinico")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:familyRecordNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:familyRecordNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:familyRecordNumber.type.codingextensiblePattern Value: MR("Numero de processo clinico familiar")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:birthRegistryNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:birthRegistryNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:birthRegistryNumber.type.codingextensiblePattern Value: BR("Cédula de Nascimento")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.3.0
From the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.3.0
From the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status|4.3.0
From the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.3.0
From the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Patient.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.3.0
From the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.3.0
From the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.3.0
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.generalPractitioner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.3.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.3.0
From the FHIR Standard
IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningPatient.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:occupation S 0..* (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonOccupation-Pt
.... extension:patient-record-type 0..* boolean Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonRecordType-Pt
.... extension:patient-enrollment-category-primarycare 0..* CodeableConcept Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientEnrollmentCategoryPrimarycare-Pt
.... extension:nationality S 0..* CodeableConcept Extension
URL: http://example.com/fhir/example/StructureDefinition/Nationality
.... extension:birthplace 0..1 (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonBirthplace-Pt
... Slices for identifier Σ 0..* Identifier An identifier for this patient
Slice: Unordered, Closed by type:type
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:residentCardNumber SΣ 0..* Identifier Número do Título de Residência
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:citizenshipCardNumber SΣ 0..* Identifier Número de Identificação Civil
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:taxIdNumber SΣ 0..* Identifier Número de Identificação Fiscal
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:socialSecurityNumber SΣ 0..* Identifier Número de Identificação da Segurança Social
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:healthCardNumber SΣ 0..* Identifier Número Nacional do Utente
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:passportNumber SΣ 0..* Identifier Número do Passaporte
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:patientInternalIdentifier SΣ 0..* Identifier Número Interno do Utente
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:militaryIDNumber SΣ 0..* Identifier Número da Cédula Militar
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:medicalRecordNumber SΣ 0..* Identifier Numero de processo Clinico
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:familyRecordNumber SΣ 0..* Identifier Numero de processo clinico familiar
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... identifier:birthRegistryNumber SΣ 0..* Identifier Cédula de Nascimento
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..1 HumanName A name associated with the patient
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:addressType S 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
..... extension:municipality S 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
..... extension:county S 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
..... extension:parish S 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
..... extension:nuts S 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
... contact SC 0..1 BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
.... Slices for extension Content/Rules for all slices
..... extension:patient-primary-care-period S 0..* Period Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientPrimaryCarePeriod-Pt
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:residentCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:citizenshipCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:taxIdNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:socialSecurityNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:healthCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:passportNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:patientInternalIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:militaryIDNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:medicalRecordNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:familyRecordNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:birthRegistryNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.3.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id S 1..1 id Logical id of this artifact
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:occupation S 0..* (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonOccupation-Pt
.... extension:patient-record-type 0..* boolean Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonRecordType-Pt
.... extension:patient-enrollment-category-primarycare 0..* CodeableConcept Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientEnrollmentCategoryPrimarycare-Pt
.... extension:nationality S 0..* CodeableConcept Extension
URL: http://example.com/fhir/example/StructureDefinition/Nationality
.... extension:birthplace 0..1 (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonBirthplace-Pt
... Slices for identifier 0..* Identifier An identifier for this patient
Slice: Unordered, Closed by type:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..0
..... type
...... id 0..0
...... extension 0..0
...... coding 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)
.... identifier:residentCardNumber S 0..* Identifier Número do Título de Residência
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
....... display 1..1 string Representation defined by the system
Fixed Value: Número do Título de Residência
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número do Título de Residência
.... identifier:citizenshipCardNumber S 0..* Identifier Número de Identificação Civil
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CZ
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Identificação Civil
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação Civil
.... identifier:taxIdNumber S 0..* Identifier Número de Identificação Fiscal
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Identificação Fiscal
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação Fiscal
.... identifier:socialSecurityNumber S 0..* Identifier Número de Identificação da Segurança Social
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Segurança Social
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação da Segurança Social
.... identifier:healthCardNumber S 0..* Identifier Número Nacional do Utente
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: HC
....... display 1..1 string Representation defined by the system
Fixed Value: Número Nacional do Utente
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número Nacional do Utente
.... identifier:passportNumber S 0..* Identifier Número do Passaporte
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Passaporte
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número do Passaporte
.... identifier:patientInternalIdentifier S 0..* Identifier Número Interno do Utente
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Número Interno do Utente
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número Interno do Utente
.... identifier:militaryIDNumber S 0..* Identifier Número da Cédula Militar
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MI
....... display 1..1 string Representation defined by the system
Fixed Value: Número da Cédula Militar
...... text 0..1 string Plain text representation of the concept
Required Pattern: Número da Cédula Militar
.... identifier:medicalRecordNumber S 0..* Identifier Numero de processo Clinico
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Numero de processo Clinico
...... text 0..1 string Plain text representation of the concept
Required Pattern: Numero de processo Clinico
.... identifier:familyRecordNumber S 0..* Identifier Numero de processo clinico familiar
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Numero de processo clinico familiar
...... text 0..1 string Plain text representation of the concept
Required Pattern: Numero de processo clinico familiar
.... identifier:birthRegistryNumber S 0..* Identifier Cédula de Nascimento
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BR
....... display 1..1 string Representation defined by the system
Fixed Value: Cédula de Nascimento
...... text 0..1 string Plain text representation of the concept
Required Pattern: Cédula de Nascimento
... telecom S 0..* ContactPoint A contact detail for the individual
... address
.... Slices for extension Content/Rules for all slices
..... extension:addressType S 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
..... extension:municipality S 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
..... extension:county S 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
..... extension:parish S 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
..... extension:nuts S 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
... contact S 0..1 BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
.... address
..... Slices for extension Content/Rules for all slices
...... extension:addressType 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
...... extension:municipality 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
...... extension:county 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
...... extension:parish 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
...... extension:nuts 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
... generalPractitioner
.... Slices for extension Content/Rules for all slices
..... extension:patient-primary-care-period S 0..* Period Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientPrimaryCarePeriod-Pt

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.identifier.type.codingextensibleVS_PatientIdentifierType
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id SΣ 1..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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:occupation S 0..* (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonOccupation-Pt
.... extension:patient-record-type 0..* boolean Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonRecordType-Pt
.... extension:patient-enrollment-category-primarycare 0..* CodeableConcept Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientEnrollmentCategoryPrimarycare-Pt
.... extension:nationality S 0..* CodeableConcept Extension
URL: http://example.com/fhir/example/StructureDefinition/Nationality
.... extension:birthplace 0..1 (Complex) Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PersonBirthplace-Pt
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier An identifier for this patient
Slice: Unordered, Closed by type:type
.... identifier:All Slices Content/Rules for all slices
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:residentCardNumber SΣ 0..* Identifier Número do Título de Residência
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRC
....... display 1..1 string Representation defined by the system
Fixed Value: Número do Título de Residência
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número do Título de Residência
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:citizenshipCardNumber SΣ 0..* Identifier Número de Identificação Civil
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CZ
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Identificação Civil
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação Civil
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:taxIdNumber SΣ 0..* Identifier Número de Identificação Fiscal
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Identificação Fiscal
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação Fiscal
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:socialSecurityNumber SΣ 0..* Identifier Número de Identificação da Segurança Social
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SS
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Segurança Social
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número de Identificação da Segurança Social
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:healthCardNumber SΣ 0..* Identifier Número Nacional do Utente
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: HC
....... display 1..1 string Representation defined by the system
Fixed Value: Número Nacional do Utente
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número Nacional do Utente
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:passportNumber SΣ 0..* Identifier Número do Passaporte
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 1..1 string Representation defined by the system
Fixed Value: Número de Passaporte
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número do Passaporte
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:patientInternalIdentifier SΣ 0..* Identifier Número Interno do Utente
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PI
....... display 1..1 string Representation defined by the system
Fixed Value: Número Interno do Utente
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número Interno do Utente
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:militaryIDNumber SΣ 0..* Identifier Número da Cédula Militar
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MI
....... display 1..1 string Representation defined by the system
Fixed Value: Número da Cédula Militar
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Número da Cédula Militar
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:medicalRecordNumber SΣ 0..* Identifier Numero de processo Clinico
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Numero de processo Clinico
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Numero de processo Clinico
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:familyRecordNumber SΣ 0..* Identifier Numero de processo clinico familiar
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Numero de processo clinico familiar
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Numero de processo clinico familiar
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... identifier:birthRegistryNumber SΣ 0..* Identifier Cédula de Nascimento
..... 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)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
...... extension 0..0
...... coding Σ 0..* Coding Code defined by a terminology system
Binding: Tipos de Identificadores de Paciente (extensible)

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.pt/fhir/identifier-type
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BR
....... display 1..1 string Representation defined by the system
Fixed Value: Cédula de Nascimento
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Cédula de Nascimento
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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Σ 1..1 HumanName A name associated with the patient
... telecom SΣ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..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 Σ 0..* Address An address for the individual
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:addressType S 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
..... extension:municipality S 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
..... extension:county S 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
..... extension:parish S 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
..... extension:nuts S 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
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
.... line Σ 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 Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... 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)
.... 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 SC 0..1 BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:addressType 0..* Coding Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressType-Pt
...... extension:municipality 0..* CodeableConcept Codigo do concelho
URL: http://example.com/fhir/example/StructureDefinition/AddressMunicipality-Pt
...... extension:county 0..* CodeableConcept Codigo do distrito
URL: http://example.com/fhir/example/StructureDefinition/AddressCounty-Pt
...... extension:parish 0..* CodeableConcept Código da Freguesia
URL: http://example.com/fhir/example/StructureDefinition/AddressParish-Pt
...... extension:nuts 0..* (Complex) Extension
URL: http://example.com/fhir/example/StructureDefinition/AddressNuts-Pt
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
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
..... line Σ 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 Σ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state Σ 0..1 string Sub-unit of country (abbreviations ok)
..... 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)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... 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): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:patient-primary-care-period S 0..* Period Optional Extensions Element
URL: http://example.com/fhir/example/StructureDefinition/PatientPrimaryCarePeriod-Pt
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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.

doco Documentation for this format

Terminology Bindings

Constraints

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.3.0
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier.type.codingextensibleVS_PatientIdentifierType
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:residentCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:residentCardNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:residentCardNumber.type.codingextensiblePattern Value: PRC("Número do Título de Residência")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:citizenshipCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:citizenshipCardNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:citizenshipCardNumber.type.codingextensiblePattern Value: CZ("Número de Identificação Civil")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:taxIdNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:taxIdNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:taxIdNumber.type.codingextensiblePattern Value: TAX("Número de Identificação Fiscal")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:socialSecurityNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:socialSecurityNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:socialSecurityNumber.type.codingextensiblePattern Value: SS("Número de Segurança Social")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:healthCardNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:healthCardNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:healthCardNumber.type.codingextensiblePattern Value: HC("Número Nacional do Utente")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:passportNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:passportNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:passportNumber.type.codingextensiblePattern Value: PPN("Número de Passaporte")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:patientInternalIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:patientInternalIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:patientInternalIdentifier.type.codingextensiblePattern Value: PI("Número Interno do Utente")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:militaryIDNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:militaryIDNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:militaryIDNumber.type.codingextensiblePattern Value: MI("Número da Cédula Militar")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:medicalRecordNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:medicalRecordNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:medicalRecordNumber.type.codingextensiblePattern Value: MR("Numero de processo Clinico")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:familyRecordNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:familyRecordNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:familyRecordNumber.type.codingextensiblePattern Value: MR("Numero de processo clinico familiar")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.identifier:birthRegistryNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
From the FHIR Standard
Patient.identifier:birthRegistryNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.3.0
From the FHIR Standard
Patient.identifier:birthRegistryNumber.type.codingextensiblePattern Value: BR("Cédula de Nascimento")
http://example.com/fhir/example/ValueSet/patient-identifier-type
From this IG
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.3.0
From the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.3.0
From the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status|4.3.0
From the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.3.0
From the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.3.0
From the FHIR Standard
Patient.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.3.0
From the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.3.0
From the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.3.0
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.generalPractitioner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.3.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.3.0
From the FHIR Standard
IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
dom-r4bwarningPatient.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

 

Other representations of profile: CSV, Excel, Schematron