International Patient Summary Implementation Guide Implementation Guide: STU2 Ballot

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

SD.31 StructureDefinition-patient-uv-ips

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.

Conformance resource variables defined here

SD.31.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/patient-uv-ips

Published on Wed Mar 21 01:43:56 AEST 2018 as a draft by .

This profile builds on Patient

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 27 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*Information about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAn identifier for this patient
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ0..*HumanNameA name associated with the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text Σ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..1stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the individual
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ1..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address SΣ0..*AddressAn address for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General': 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact SI0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... relationship SI0..*CodeableConcept-uv-ipsThe kind of relationship
Binding: IPS Personal Relationship (required)
.... name S0..1HumanNameA name associated with the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ0..1stringText representation of the full name
..... family SΣ0..1stringFamily name (often called 'Surname')
..... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointA contact detail for the person
.... address S0..1AddressAddress for the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
..... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
..... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
..... city SΣ0..1stringName of city, town etc.
Example General': Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General': Madison
..... state SΣ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General': 9132
..... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization SI0..1Reference(Organization)Organization that is associated with the contact
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... display Σ0..1stringText alternative for the resource
.... period 0..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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Common Languages (preferred)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner S0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... display Σ0..1stringText alternative for the resource
... managingOrganization Σ0..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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron