HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
0.0.1 - 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 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions

Resource Profile: PT_Patient

Official URL: http://hl7.pt/fhir/core/StructureDefinition/176c7c2b-865c-4942-9bd6-cfaa04678d10 Version: 0.0.1
Active as of 2024-09-23 Computable Name: PT_Patient

A generic Patient resource for Portugal

Usage:

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Nationality 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/a4126b30-e00e-451a-830c-4db050c60cdf
.... BirthPlace 0..1 Address Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/63310252-7722-4031-8f01-a2c642d0f2a7
... identifier
.... use 0..1 code usual | official | temp | secondary | old (If known)
.... type 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible): HL7-defined code system of concepts specifying type of identifier.

..... coding
...... system 0..1 uri Identity of the terminology system
.... assigner 0..1 Reference(PT_Organization) Organization that issued id (may be just text)
... Slices for deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedBoolean 0..1 boolean Indicates if the individual is deceased or not
.... Slices for extension Content/Rules for all slices
..... Parish 0..1 CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-2 (preferred)
.... period
..... start 0..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... maritalStatus
.... coding
..... system 0..1 uri Identity of the terminology system
... multipleBirth[x] S 0..1 boolean, integer Whether patient is part of a multiple birth
... contact
.... relationship
..... coding 0..* Coding Code defined by a terminology system
...... system 0..1 uri Identity of the terminology system
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
..... text 0..1 string Plain text representation of the concept
.... telecom
..... value 0..1 string The actual contact point details
.... address
..... Slices for extension Content/Rules for all slices
...... Parish 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
....... value[x] 0..1 CodeableConcept Value of extension
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes

..... period
...... start 0..1 dateTime Starting time with inclusive boundary
...... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... generalPractitioner 0..* Reference(PT_Practitioner | PT_PractitionerRole) Patient's nominated primary care provider

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
Patient.address.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.contact.address.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... 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
.... Nationality 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/a4126b30-e00e-451a-830c-4db050c60cdf
.... BirthPlace 0..1 Address Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/63310252-7722-4031-8f01-a2c642d0f2a7
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Indicates if the individual is deceased or not
... multipleBirth[x] S 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... generalPractitioner 0..* Reference(PT_Practitioner | PT_PractitionerRole) Patient's nominated primary care provider
... 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.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Nationality 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/a4126b30-e00e-451a-830c-4db050c60cdf
.... BirthPlace 0..1 Address Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/63310252-7722-4031-8f01-a2c642d0f2a7
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier An identifier for this patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible): HL7-defined code system of concepts specifying type of identifier.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... 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(PT_Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
... telecom Σ 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
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Indicates if the individual is deceased or not
... address Σ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Parish 0..1 CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... 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)
Binding: Iso3166-1-2 (preferred)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... multipleBirth[x] S 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Parish 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.pt/fhir/core/StructureDefinition/PTAddress"
....... value[x] 0..1 CodeableConcept Value of extension
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code Σ 0..1 code Symbol in syntax defined by the system
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... 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)
Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes

..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(PT_Practitioner | PT_PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.contact.address.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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 & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Nationality 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/a4126b30-e00e-451a-830c-4db050c60cdf
.... BirthPlace 0..1 Address Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/63310252-7722-4031-8f01-a2c642d0f2a7
... identifier
.... use 0..1 code usual | official | temp | secondary | old (If known)
.... type 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible): HL7-defined code system of concepts specifying type of identifier.

..... coding
...... system 0..1 uri Identity of the terminology system
.... assigner 0..1 Reference(PT_Organization) Organization that issued id (may be just text)
... Slices for deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedBoolean 0..1 boolean Indicates if the individual is deceased or not
.... Slices for extension Content/Rules for all slices
..... Parish 0..1 CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-2 (preferred)
.... period
..... start 0..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... maritalStatus
.... coding
..... system 0..1 uri Identity of the terminology system
... multipleBirth[x] S 0..1 boolean, integer Whether patient is part of a multiple birth
... contact
.... relationship
..... coding 0..* Coding Code defined by a terminology system
...... system 0..1 uri Identity of the terminology system
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
..... text 0..1 string Plain text representation of the concept
.... telecom
..... value 0..1 string The actual contact point details
.... address
..... Slices for extension Content/Rules for all slices
...... Parish 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
....... value[x] 0..1 CodeableConcept Value of extension
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes

..... period
...... start 0..1 dateTime Starting time with inclusive boundary
...... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... generalPractitioner 0..* Reference(PT_Practitioner | PT_PractitionerRole) Patient's nominated primary care provider

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
Patient.address.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.contact.address.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... 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
.... Nationality 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/a4126b30-e00e-451a-830c-4db050c60cdf
.... BirthPlace 0..1 Address Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/63310252-7722-4031-8f01-a2c642d0f2a7
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Indicates if the individual is deceased or not
... multipleBirth[x] S 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... generalPractitioner 0..* Reference(PT_Practitioner | PT_PractitionerRole) Patient's nominated primary care provider
... 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.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... Nationality 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/a4126b30-e00e-451a-830c-4db050c60cdf
.... BirthPlace 0..1 Address Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/63310252-7722-4031-8f01-a2c642d0f2a7
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier An identifier for this patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible): HL7-defined code system of concepts specifying type of identifier.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... 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(PT_Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
... telecom Σ 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
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean Indicates if the individual is deceased or not
... address Σ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Parish 0..1 CodeableConcept Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... 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)
Binding: Iso3166-1-2 (preferred)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... multipleBirth[x] S 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... Parish 0..1 (Complex) Extension
URL: http://hl7.pt/fhir/core/StructureDefinition/PTAddress
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.pt/fhir/core/StructureDefinition/PTAddress"
....... value[x] 0..1 CodeableConcept Value of extension
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code Σ 0..1 code Symbol in syntax defined by the system
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... 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)
Binding: Iso3166-1-2 (preferred): This value set defines the ISO 3166 Part 1 2-letter codes

..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(PT_Practitioner | PT_PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.contact.address.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()

 

Other representations of profile: CSV, Excel, Schematron