International Patient Summary Implementation Guide
1.0.0 - STU 1

This page is part of the International Patient Summary Implementation Guide (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: 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.

The official URL for this profile is: 

http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips

Formal Views of Profile Content

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

This structure is derived from Patient

Summary

Mandatory: 3 elements
Must-Support: 18 elements

Structures

This structure refers to these other structures:

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient S0..*PatientInformation about an individual or animal receiving health care services
... identifier S0..*IdentifierAn identifier for this patient
... name SI1..*HumanNameA name associated with the patient
ips-pat-1: Patient.name.given or Patient.name.family or both SHALL be present
.... text S0..1stringText representation of the full name
.... family S0..1stringFamily name (often called 'Surname')
.... given S0..*stringGiven names (not always 'first'). Includes middle names
... telecom S0..*ContactPointA contact detail for the individual
... birthDate S1..1dateThe date of birth for the individual
... address SI0..*AddressAn address for the individual
pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
... contact S0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... relationship S0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Personal Relationship - IPS (required)
.... name S0..1HumanNameA name associated with the contact person
.... telecom S0..*ContactPointA contact detail for the person
.... address S0..1AddressAddress for the contact person
.... organization S0..1Reference(Organization)Organization that is associated with the contact
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required)
... generalPractitioner S0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient SI0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierAn identifier for this patient
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name SΣI1..*HumanNameA name associated with the patient
ips-pat-1: Patient.name.given or Patient.name.family or both SHALL be present
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text SΣI0..1stringText representation of the full name
.... family SΣI0..1stringFamily name (often called 'Surname')
.... given SΣI0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix ΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period ΣI0..1PeriodTime period when name was/is in use
... telecom SΣI0..*ContactPointA contact detail for the individual
... gender SΣI1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣI1..1dateThe date of birth for the individual
... deceased[x] ?!ΣI0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣI0..*AddressAn address for the individual
pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*AttachmentImage of the patient
... contact SI0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship SI0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Personal Relationship - IPS (required)
.... name SI0..1HumanNameA name associated with the contact person
.... telecom SI0..*ContactPointA contact detail for the person
.... address SI0..1AddressAddress for the contact person
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization SI0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication SI0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language SI1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required)
.... preferred I0..1booleanLanguage preference indicator
... generalPractitioner SI0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 3 elements
Must-Support: 18 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient S0..*PatientInformation about an individual or animal receiving health care services
... identifier S0..*IdentifierAn identifier for this patient
... name SI1..*HumanNameA name associated with the patient
ips-pat-1: Patient.name.given or Patient.name.family or both SHALL be present
.... text S0..1stringText representation of the full name
.... family S0..1stringFamily name (often called 'Surname')
.... given S0..*stringGiven names (not always 'first'). Includes middle names
... telecom S0..*ContactPointA contact detail for the individual
... birthDate S1..1dateThe date of birth for the individual
... address SI0..*AddressAn address for the individual
pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
... contact S0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... relationship S0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Personal Relationship - IPS (required)
.... name S0..1HumanNameA name associated with the contact person
.... telecom S0..*ContactPointA contact detail for the person
.... address S0..1AddressAddress for the contact person
.... organization S0..1Reference(Organization)Organization that is associated with the contact
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required)
... generalPractitioner S0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient SI0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*IdentifierAn identifier for this patient
... active ?!ΣI0..1booleanWhether this patient's record is in active use
... name SΣI1..*HumanNameA name associated with the patient
ips-pat-1: Patient.name.given or Patient.name.family or both SHALL be present
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text SΣI0..1stringText representation of the full name
.... family SΣI0..1stringFamily name (often called 'Surname')
.... given SΣI0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix ΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period ΣI0..1PeriodTime period when name was/is in use
... telecom SΣI0..*ContactPointA contact detail for the individual
... gender SΣI1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣI1..1dateThe date of birth for the individual
... deceased[x] ?!ΣI0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣI0..*AddressAn address for the individual
pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
... maritalStatus I0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] I0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo I0..*AttachmentImage of the patient
... contact SI0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship SI0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Personal Relationship - IPS (required)
.... name SI0..1HumanNameA name associated with the contact person
.... telecom SI0..*ContactPointA contact detail for the person
.... address SI0..1AddressAddress for the contact person
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization SI0..1Reference(Organization)Organization that is associated with the contact
.... period I0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication SI0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language SI1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required)
.... preferred I0..1booleanLanguage preference indicator
... generalPractitioner SI0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization ΣI0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣI1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type ΣI1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.name.userequiredNameUse
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshiprequiredPersonalRelationshipUvIps
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagerequiredAllLanguages
Patient.link.typerequiredLinkType

Constraints

Constraints

IdPathDetailsRequirements
dom-2PatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3PatientIf 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-4PatientIf 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-5PatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1Patient.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ips-pat-1Patient.namePatient.name.given or Patient.name.family or both SHALL be present
: family.exists() or given.exists()
ele-1Patient.name.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.name.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.name.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.familyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.givenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.prefixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.suffixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.deceased[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pat-cnt-2or3-charPatient.addressThe content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2.
: country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ele-1Patient.maritalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.multipleBirth[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.photoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pat-1Patient.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()
ele-1Patient.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communication.preferredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.generalPractitionerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.link.otherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.link.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())