PCC - mobile Paramedicine Summary of Care (mPSC)
2.0.0-draft - ci-build International flag

PCC - mobile Paramedicine Summary of Care (mPSC), published by IHE Patient Care Coordination. This guide is not an authorized publication; it is the continuous build for version 2.0.0-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/PCC.PCS/ and changes regularly. See the Directory of published versions

Resource Profile: IHE PCC Patient

Official URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/IHE.PCC.Patient Version: 2.0.0-draft
Draft as of 2025-10-30 Computable Name: IHE_PCC_Patient

Combines the requirements and contraints from IPS, and PDQ profiles. review https://profiles.ihe.net/ITI/PDQm/3.1.0/StructureDefinition-IHE.PDQm.Patient.html for additional constraints and descriptions.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: iti-pdqm-linkstatus
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:genderIdentity 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]] The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
.... extension:personalPronouns 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]] The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1
.... extension:MothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
.... extension:UvRace 0..* CodeableConcept Universal realm Race Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-race
.... extension:UvEthnicity 0..* CodeableConcept Universal realm Ethnicity Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-ethnicity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SOΣ 0..* Identifier An identifier for this patient
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1, iti-pdqm-patname, ihe-pcc-pat-1
ObligationsActorSource
SHALL:populate Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... text SOΣ 0..1 string Text representation of the full name
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... gender SOΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... birthDate SOΣ 1..1 date The date of birth for the individual
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... generalPractitioner SO 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... link ?!SΣC 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 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-4 error Patient If 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ihe-pcc-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
iti-pdqm-linkstatus error Patient If Patient.link is present, then Patient.active SHALL be present link.exists() implies active.exists()
iti-pdqm-patname error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from PatientUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: iti-pdqm-linkstatus
... Slices for extension Content/Rules for all slices
.... extension:MothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
.... extension:UvRace 0..* CodeableConcept Universal realm Race Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-race
.... extension:UvEthnicity 0..* CodeableConcept Universal realm Ethnicity Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-ethnicity
... active S 0..1 boolean Whether this patient's record is in active use
... name C 1..* HumanName A name associated with the patient
Constraints: iti-pdqm-patname, ihe-pcc-pat-1
... link SC 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... type 1..1 code replaced-by | replaces | refer | seealso

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ihe-pcc-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
iti-pdqm-linkstatus error Patient If Patient.link is present, then Patient.active SHALL be present link.exists() implies active.exists()
iti-pdqm-patname error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: iti-pdqm-linkstatus
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:genderIdentity 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]] The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
.... extension:personalPronouns 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]] The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1
.... extension:MothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
.... extension:UvRace 0..* CodeableConcept Universal realm Race Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-race
.... extension:UvEthnicity 0..* CodeableConcept Universal realm Ethnicity Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-ethnicity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SOΣ 0..* Identifier An identifier for this patient
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1, iti-pdqm-patname, ihe-pcc-pat-1
ObligationsActorSource
SHALL:populate Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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 ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... text SOΣ 0..1 string Text representation of the full name
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... gender SOΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... birthDate SOΣ 1..1 date The date of birth for the individual
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... 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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!SΣC 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

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 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-4 error Patient If 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ihe-pcc-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
iti-pdqm-linkstatus error Patient If Patient.link is present, then Patient.active SHALL be present link.exists() implies active.exists()
iti-pdqm-patname error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: iti-pdqm-linkstatus
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:genderIdentity 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]] The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
.... extension:personalPronouns 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]] The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1
.... extension:MothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
.... extension:UvRace 0..* CodeableConcept Universal realm Race Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-race
.... extension:UvEthnicity 0..* CodeableConcept Universal realm Ethnicity Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-ethnicity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SOΣ 0..* Identifier An identifier for this patient
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1, iti-pdqm-patname, ihe-pcc-pat-1
ObligationsActorSource
SHALL:populate Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... use ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... text SOΣ 0..1 string Text representation of the full name
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... gender SOΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... birthDate SOΣ 1..1 date The date of birth for the individual
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... generalPractitioner SO 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... link ?!SΣC 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 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-4 error Patient If 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ihe-pcc-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
iti-pdqm-linkstatus error Patient If Patient.link is present, then Patient.active SHALL be present link.exists() implies active.exists()
iti-pdqm-patname error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Differential View

This structure is derived from PatientUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: iti-pdqm-linkstatus
... Slices for extension Content/Rules for all slices
.... extension:MothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
.... extension:UvRace 0..* CodeableConcept Universal realm Race Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-race
.... extension:UvEthnicity 0..* CodeableConcept Universal realm Ethnicity Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-ethnicity
... active S 0..1 boolean Whether this patient's record is in active use
... name C 1..* HumanName A name associated with the patient
Constraints: iti-pdqm-patname, ihe-pcc-pat-1
... link SC 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... type 1..1 code replaced-by | replaces | refer | seealso

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ihe-pcc-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
iti-pdqm-linkstatus error Patient If Patient.link is present, then Patient.active SHALL be present link.exists() implies active.exists()
iti-pdqm-patname error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* PatientUvIps Information about an individual or animal receiving health care services
Constraints: iti-pdqm-linkstatus
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:genderIdentity 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]] The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
.... extension:personalPronouns 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]] The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1
.... extension:MothersMaidenName 0..1 string Mother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
.... extension:recordedSexOrGender 0..* (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
.... extension:UvRace 0..* CodeableConcept Universal realm Race Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-race
.... extension:UvEthnicity 0..* CodeableConcept Universal realm Ethnicity Extension
URL: https://profiles.ihe.net/PCC/mPSC/StructureDefinition/pcc-uv-ethnicity
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SOΣ 0..* Identifier An identifier for this patient
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use
... name SOΣC 1..* HumanName A name associated with the patient
Constraints: ips-pat-1, iti-pdqm-patname, ihe-pcc-pat-1
ObligationsActorSource
SHALL:populate Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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 ?!SOΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... text SOΣ 0..1 string Text representation of the full name
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
.... family SOΣ 0..1 string Family name (often called 'Surname')
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... gender SOΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... birthDate SOΣ 1..1 date The date of birth for the individual
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (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
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... 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
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Patient (IPS)
SHALL:handle Consumer (IPS) from Patient (IPS)
SHOULD:display Consumer (IPS) from Patient (IPS)
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!SΣC 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

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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 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-4 error Patient If 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ihe-pcc-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
ips-pat-1 error Patient.name Patient.name.given, Patient.name.family or Patient.name.text SHALL be present family.exists() or given.exists() or text.exists()
iti-pdqm-linkstatus error Patient If Patient.link is present, then Patient.active SHALL be present link.exists() implies active.exists()
iti-pdqm-patname error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

 

Other representations of profile: CSV, Excel, Schematron