International Patient Summary Implementation Guide
2.0.0 - STU 2 International flag

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

Resource Profile: Patient (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips Version: 2.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: PatientUvIps

This profile represents the constraints applied to the Patient resource by the International Patient Summary (IPS) FHIR Implementation Guide and describes the minimum expectations for the Patient resource when used in the IPS composition or in one of the referred resources.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:genderIdentity 0..* (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:personalPronouns 0..* (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
ele-1: All FHIR elements must have a @value or children
... name SOΣC 1..* HumanName A name associated with the patient
ele-1: All FHIR elements must have a @value or children
ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
.... text SOΣ 0..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... family SOΣ 0..1 string Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... gender SOΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... birthDate SOΣ 1..1 date The date of birth for the individual
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SOΣ 0..* Address An address for the individual
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... generalPractitioner SO 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
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()
ips-pat-1errorPatient.namePatient.name.given, Patient.name.family or Patient.name.text SHALL be present
: family.exists() or given.exists() or text.exists()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:genderIdentity 0..* (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:personalPronouns 0..* (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... identifier SO 0..* Identifier An identifier for this patient
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... name SOC 1..* HumanName A name associated with the patient
ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... text SO 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... family SO 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... given SO 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... gender SO 0..1 code male | female | other | unknown
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... birthDate SO 1..1 date The date of birth for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... address SO 0..* Address An address for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... contact
.... relationship 0..* CodeableConceptIPS The kind of relationship
... generalPractitioner SO 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ips-pat-1errorPatient.namePatient.name.given, Patient.name.family or Patient.name.text SHALL be present
: family.exists() or given.exists() or text.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
.... extension:genderIdentity 0..* (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:personalPronouns 0..* (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SOΣ 0..* Identifier An identifier for this patient
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SOΣ 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... gender SOΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... birthDate SOΣ 1..1 date The date of birth for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SOΣ 0..* Address An address for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConceptIPS The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... 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 SO 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... 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
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
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.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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()
ips-pat-1errorPatient.namePatient.name.given, Patient.name.family or Patient.name.text SHALL be present
: family.exists() or given.exists() or text.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

Summary

Mandatory: 2 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:genderIdentity 0..* (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:personalPronouns 0..* (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
ele-1: All FHIR elements must have a @value or children
... name SOΣC 1..* HumanName A name associated with the patient
ele-1: All FHIR elements must have a @value or children
ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
.... text SOΣ 0..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... family SOΣ 0..1 string Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... gender SOΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... birthDate SOΣ 1..1 date The date of birth for the individual
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SOΣ 0..* Address An address for the individual
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... generalPractitioner SO 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
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()
ips-pat-1errorPatient.namePatient.name.given, Patient.name.family or Patient.name.text SHALL be present
: family.exists() or given.exists() or text.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:genderIdentity 0..* (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:personalPronouns 0..* (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... identifier SO 0..* Identifier An identifier for this patient
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... name SOC 1..* HumanName A name associated with the patient
ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... text SO 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... family SO 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... given SO 0..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... gender SO 0..1 code male | female | other | unknown
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... birthDate SO 1..1 date The date of birth for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... address SO 0..* Address An address for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... contact
.... relationship 0..* CodeableConceptIPS The kind of relationship
... generalPractitioner SO 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ips-pat-1errorPatient.namePatient.name.given, Patient.name.family or Patient.name.text SHALL be present
: family.exists() or given.exists() or text.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
.... extension:genderIdentity 0..* (Complex) The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:personalPronouns 0..* (Complex) The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SOΣ 0..* Identifier An identifier for this patient
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SOΣ 0..1 string Text representation of the full name
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... given SOΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... gender SOΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... birthDate SOΣ 1..1 date The date of birth for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SOΣ 0..* Address An address for the individual
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConceptIPS The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... 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 SO 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ObligationsActor
SHALL:populate-if-known Producer (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... 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
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
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.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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()
ips-pat-1errorPatient.namePatient.name.given, Patient.name.family or Patient.name.text SHALL be present
: family.exists() or given.exists() or text.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

Summary

Mandatory: 2 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron