Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.

Resource Profile: CareConnectPatient1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1 Version: 0.1.0
Draft as of 2019-05-31 Computable Name: CareConnectPatient1

Copyright/Legal: Copyright © 2019 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html

The patient resource represents the patient involved in the provision of healthcare related services.

CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/

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..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicCategory 0..1CodeableConceptEthnic category
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity.

... religiousAffiliation 0..1CodeableConceptReligious affiliation
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1
Binding: Care Connect Religious Affiliation (required): Religious Affiliation

... residentialStatus 0..1CodeableConceptThe residential status of the patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Binding: Care Connect Residential Status (required): Residential Status

... treatmentCategory 0..1CodeableConceptThe treatment category for this patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Binding: Care Connect Treatment Category (required): Treatment Category

... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... birthPlace 0..1AddressBirth Place: The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... nominatedPharmacy 0..1Reference(CareConnect-Organization-1)A patient's nominated pharmacy
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
... deathNotificationStatus 0..1(Complex)Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS))
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
... Slices for identifier 0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:nhsNumber 0..1IdentifierThe patient's NHS number
..... extension 1..*ExtensionExtension
..... nhsNumberVerificationStatus 1..1CodeableConceptNHS number verification status
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status

..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value 1..1stringThe value that is unique
Example General: 1234567890
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... Slices for name 1..*HumanNameA name associated with the patient
Slice: Unordered, Open At End by value:use
.... name:official 1..1HumanNameA name associated with the patient
..... use 1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family 1..1stringFamily name (often called 'Surname')
... telecom
.... system 1..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patient-birthTime 0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... address
.... text 0..1stringText representation of the address
Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF
.... line 0..*stringStreet name, number, direction & P.O. Box etc.
Example General: 42 Grove Street
.... city 0..1stringName of city, town etc.
Example General: Overtown
.... district 0..1stringDistrict name (aka county)
Example General: West Yorkshire
.... postalCode 0..1stringPostal code for area
Example General: LS21 1PF
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Example General: GBR
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.

.... coding 1..1CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Example General: http://hl7.org/fhir/v3/MaritalStatus
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... contact
.... name 1..1HumanNameA name associated with the contact person
..... use 1..1codeusual | official | temp | nickname | anonymous | old | maiden
.... address
..... text 0..1stringText representation of the address
Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT
..... line 0..*stringStreet name, number, direction & P.O. Box etc.
Example General: 120, Grove Street
..... city 0..1stringName of city, town etc.
Example General: Overtown
..... district 0..1stringDistrict name (aka county)
Example General: West Yorkshire
..... postalCode 0..1stringPostal code for area
Example General: LS21 1PT
..... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Example General: GBR
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization 0..1Reference(CareConnect-Organization-1)Organization that is associated with the contact
... animal 0..0
... communication 0..0
... managingOrganization 0..1Reference(CareConnect-Organization-1)Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Patient.name:official.userequiredFixed Value: official
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredMarital Status Codes
Patient.contact.genderrequiredAdministrativeGender
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicCategory 0..1CodeableConceptEthnic category
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity.


... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... residentialStatus 0..1CodeableConceptThe residential status of the patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Binding: Care Connect Residential Status (required): Residential Status


... treatmentCategory 0..1CodeableConceptThe treatment category for this patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Binding: Care Connect Treatment Category (required): Treatment Category


... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... birthPlace 0..1AddressBirth Place: The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... nominatedPharmacy 0..1Reference(CareConnect-Organization-1)A patient's nominated pharmacy
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
... deathNotificationStatus 0..1(Complex)Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS))
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:nhsNumber Σ0..1IdentifierThe patient's NHS number
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... nhsNumberVerificationStatus 1..1CodeableConceptNHS number verification status
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status


..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example General: 1234567890
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name Σ1..*HumanNameA name associated with the patient
Slice: Unordered, Open At End by value:use
.... name:official Σ1..1HumanNameA name associated with the patient
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family Σ1..1stringFamily name (often called 'Surname')
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.

.... coding Σ1..1CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Example General: http://hl7.org/fhir/v3/MaritalStatus
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso - type of link
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.identifier:nhsNumber.userequiredIdentifierUse
Patient.name:official.userequiredFixed Value: official
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredMarital Status Codes
Patient.animal.speciesexampleAnimalSpecies
Patient.communication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPatientIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1errorPatient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.linkAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorPatient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatusMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicCategory 0..1CodeableConceptEthnic category
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity.


... religiousAffiliation 0..1CodeableConceptReligious affiliation
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1
Binding: Care Connect Religious Affiliation (required): Religious Affiliation


... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... residentialStatus 0..1CodeableConceptThe residential status of the patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Binding: Care Connect Residential Status (required): Residential Status


... treatmentCategory 0..1CodeableConceptThe treatment category for this patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Binding: Care Connect Treatment Category (required): Treatment Category


... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... birthPlace 0..1AddressBirth Place: The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... nominatedPharmacy 0..1Reference(CareConnect-Organization-1)A patient's nominated pharmacy
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
... deathNotificationStatus 0..1(Complex)Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS))
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:nhsNumber Σ0..1IdentifierThe patient's NHS number
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... nhsNumberVerificationStatus 1..1CodeableConceptNHS number verification status
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status


..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example General: 1234567890
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name Σ1..*HumanNameA name associated with the patient
Slice: Unordered, Open At End by value:use
.... name:official Σ1..1HumanNameA name associated with the patient
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point

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

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patient-birthTime 0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAddresses for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required): The use of an address


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF
.... line Σ0..*stringStreet 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
Example General: 42 Grove Street
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
Example General: Overtown
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
Example General: West Yorkshire
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
Example General: LS21 1PF
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Example General: GBR
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Example General: http://hl7.org/fhir/v3/MaritalStatus
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: v2 Contact Role (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 1..1HumanNameA name associated with the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

..... text Σ0..1stringText representation of the full name
..... family Σ0..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required): The use of an address


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT
..... line Σ0..*stringStreet 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
Example General: 120, Grove Street
..... city Σ0..1stringName of city, town etc.
Example General: Erewhon
Example General: Overtown
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
Example General: West Yorkshire
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
Example General: LS21 1PT
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Example General: GBR
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(CareConnect-Organization-1)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... generalPractitioner 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso - type of link
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier:nhsNumber.userequiredIdentifierUse
Patient.identifier:nhsNumber.typeextensibleIdentifier Type Codes
Patient.name:official.userequiredFixed Value: official
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.maritalStatusrequiredMarital Status Codes
Patient.contact.relationshipextensiblev2 Contact Role
Patient.contact.name.userequiredNameUse
Patient.contact.address.userequiredAddressUse
Patient.contact.address.typerequiredAddressType
Patient.contact.genderrequiredAdministrativeGender
Patient.animal.speciesexampleAnimalSpecies
Patient.animal.breedexampleAnimalBreeds
Patient.animal.genderStatusexampleGenderStatus
Patient.communication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorPatient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.birthDate.extension:patient-birthTime, Patient.contact, Patient.linkAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorPatient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.birthDate.extension:patient-birthTimeMust 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

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicCategory 0..1CodeableConceptEthnic category
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity.

... religiousAffiliation 0..1CodeableConceptReligious affiliation
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1
Binding: Care Connect Religious Affiliation (required): Religious Affiliation

... residentialStatus 0..1CodeableConceptThe residential status of the patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Binding: Care Connect Residential Status (required): Residential Status

... treatmentCategory 0..1CodeableConceptThe treatment category for this patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Binding: Care Connect Treatment Category (required): Treatment Category

... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... birthPlace 0..1AddressBirth Place: The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... nominatedPharmacy 0..1Reference(CareConnect-Organization-1)A patient's nominated pharmacy
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
... deathNotificationStatus 0..1(Complex)Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS))
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
... Slices for identifier 0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:nhsNumber 0..1IdentifierThe patient's NHS number
..... extension 1..*ExtensionExtension
..... nhsNumberVerificationStatus 1..1CodeableConceptNHS number verification status
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status

..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value 1..1stringThe value that is unique
Example General: 1234567890
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... Slices for name 1..*HumanNameA name associated with the patient
Slice: Unordered, Open At End by value:use
.... name:official 1..1HumanNameA name associated with the patient
..... use 1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family 1..1stringFamily name (often called 'Surname')
... telecom
.... system 1..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patient-birthTime 0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... address
.... text 0..1stringText representation of the address
Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF
.... line 0..*stringStreet name, number, direction & P.O. Box etc.
Example General: 42 Grove Street
.... city 0..1stringName of city, town etc.
Example General: Overtown
.... district 0..1stringDistrict name (aka county)
Example General: West Yorkshire
.... postalCode 0..1stringPostal code for area
Example General: LS21 1PF
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Example General: GBR
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.

.... coding 1..1CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Example General: http://hl7.org/fhir/v3/MaritalStatus
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... contact
.... name 1..1HumanNameA name associated with the contact person
..... use 1..1codeusual | official | temp | nickname | anonymous | old | maiden
.... address
..... text 0..1stringText representation of the address
Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT
..... line 0..*stringStreet name, number, direction & P.O. Box etc.
Example General: 120, Grove Street
..... city 0..1stringName of city, town etc.
Example General: Overtown
..... district 0..1stringDistrict name (aka county)
Example General: West Yorkshire
..... postalCode 0..1stringPostal code for area
Example General: LS21 1PT
..... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Example General: GBR
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization 0..1Reference(CareConnect-Organization-1)Organization that is associated with the contact
... animal 0..0
... communication 0..0
... managingOrganization 0..1Reference(CareConnect-Organization-1)Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Patient.name:official.userequiredFixed Value: official
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredMarital Status Codes
Patient.contact.genderrequiredAdministrativeGender

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicCategory 0..1CodeableConceptEthnic category
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity.


... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... residentialStatus 0..1CodeableConceptThe residential status of the patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Binding: Care Connect Residential Status (required): Residential Status


... treatmentCategory 0..1CodeableConceptThe treatment category for this patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Binding: Care Connect Treatment Category (required): Treatment Category


... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... birthPlace 0..1AddressBirth Place: The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... nominatedPharmacy 0..1Reference(CareConnect-Organization-1)A patient's nominated pharmacy
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
... deathNotificationStatus 0..1(Complex)Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS))
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:nhsNumber Σ0..1IdentifierThe patient's NHS number
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... nhsNumberVerificationStatus 1..1CodeableConceptNHS number verification status
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status


..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example General: 1234567890
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name Σ1..*HumanNameA name associated with the patient
Slice: Unordered, Open At End by value:use
.... name:official Σ1..1HumanNameA name associated with the patient
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... family Σ1..1stringFamily name (often called 'Surname')
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.

.... coding Σ1..1CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Example General: http://hl7.org/fhir/v3/MaritalStatus
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso - type of link
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.identifier:nhsNumber.userequiredIdentifierUse
Patient.name:official.userequiredFixed Value: official
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusrequiredMarital Status Codes
Patient.animal.speciesexampleAnimalSpecies
Patient.communication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPatientIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1errorPatient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.linkAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorPatient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatusMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicCategory 0..1CodeableConceptEthnic category
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity.


... religiousAffiliation 0..1CodeableConceptReligious affiliation
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1
Binding: Care Connect Religious Affiliation (required): Religious Affiliation


... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... residentialStatus 0..1CodeableConceptThe residential status of the patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Binding: Care Connect Residential Status (required): Residential Status


... treatmentCategory 0..1CodeableConceptThe treatment category for this patient
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Binding: Care Connect Treatment Category (required): Treatment Category


... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... birthPlace 0..1AddressBirth Place: The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... nominatedPharmacy 0..1Reference(CareConnect-Organization-1)A patient's nominated pharmacy
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
... deathNotificationStatus 0..1(Complex)Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS))
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:nhsNumber Σ0..1IdentifierThe patient's NHS number
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... nhsNumberVerificationStatus 1..1CodeableConceptNHS number verification status
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status


..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example General: 1234567890
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for name Σ1..*HumanNameA name associated with the patient
Slice: Unordered, Open At End by value:use
.... name:official Σ1..1HumanNameA name associated with the patient
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Fixed Value: official
..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point

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

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... patient-birthTime 0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAddresses for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required): The use of an address


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF
.... line Σ0..*stringStreet 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
Example General: 42 Grove Street
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
Example General: Overtown
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
Example General: West Yorkshire
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
Example General: LS21 1PF
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Example General: GBR
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..1CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Example General: http://hl7.org/fhir/v3/MaritalStatus
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: v2 Contact Role (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 1..1HumanNameA name associated with the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

..... text Σ0..1stringText representation of the full name
..... family Σ0..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required): The use of an address


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


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT
..... line Σ0..*stringStreet 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
Example General: 120, Grove Street
..... city Σ0..1stringName of city, town etc.
Example General: Erewhon
Example General: Overtown
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
Example General: West Yorkshire
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
Example General: LS21 1PT
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Example General: GBR
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(CareConnect-Organization-1)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... generalPractitioner 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(CareConnect-Organization-1)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso - type of link
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.identifier:nhsNumber.userequiredIdentifierUse
Patient.identifier:nhsNumber.typeextensibleIdentifier Type Codes
Patient.name:official.userequiredFixed Value: official
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.maritalStatusrequiredMarital Status Codes
Patient.contact.relationshipextensiblev2 Contact Role
Patient.contact.name.userequiredNameUse
Patient.contact.address.userequiredAddressUse
Patient.contact.address.typerequiredAddressType
Patient.contact.genderrequiredAdministrativeGender
Patient.animal.speciesexampleAnimalSpecies
Patient.animal.breedexampleAnimalBreeds
Patient.animal.genderStatusexampleGenderStatus
Patient.communication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorPatient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.birthDate.extension:patient-birthTime, Patient.contact, Patient.linkAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorPatient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.birthDate.extension:patient-birthTimeMust 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()