STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 7.0.2. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-patient

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... active S0..1boolean
... telecom 0..*ContactPoint
.... iso21090-preferred 0..1booleanpreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... gender S0..1code
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... state 0..1stringBinding: USPS Two Letter Alphabetic Codes (preferred)
.... iso21090-preferred 0..1booleanpreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... contact 0..*BackboneElement
.... address 0..1Address
..... state 0..1stringBinding: USPS Two Letter Alphabetic Codes (preferred)
.... organization 0..1Reference(Profile qicore-organization)
... animal 0..0
... communication S0..*BackboneElement
... generalPractitioner 0..*Reference(Profile qicore-organization | Profile qicore-practitioner)
... managingOrganization 0..1Reference(Profile qicore-organization)
... link 0..*BackboneElement
.... other 1..1Reference(Profile qicore-patient)
... us-core-race S0..1CodeableConceptA category of humans sharing history, origin or nationality
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: v3 Code System Race (required)
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: v3 Code System Ethnicity (required)
... us-core-religion 0..1CodeableConceptPatient's professed religious affiliation
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (required)
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... patient-disability 0..*CodeableConceptCondition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Binding: Disability Value Set (preferred)
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... period 0..1PeriodNationality Period
URL: period
... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... extension 0..1?? http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient-militaryServiceURL: http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient-militaryService
Binding: Military Service Codes (example)
... patient-clinicalTrial 0..*(Complex)The patient's participation in clinical trials
URL: http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
.... NCT 1..1stringNational Clinical Trial number
URL: NCT
.... period 0..1PeriodThe period of participation in the clinical trial
URL: period
.... reason 0..1CodeableConceptThe reason for participation in the clinical trial
URL: reason
Binding: 7.org/fhir/daf/ValueSet/daf-problem (preferred)
... patient-birthTime S0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*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-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: v3 Code System Race (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... us-core-ethnicity SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: v3 Code System Ethnicity (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... us-core-religion I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... birthPlace I0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... patient-disability I0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Binding: Disability Value Set (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... patient-nationality I0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..1ExtensionNationality Code
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"code"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... extension 0..1ExtensionNationality Period
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"period"
..... valuePeriod 1..1PeriodValue of extension
.... period 0..1PeriodExtension
URL: period
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... patient-cadavericDonor I0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... extension 0..1?? http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient-militaryServiceExtension
URL: http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient-militaryService
Binding: Military Service Codes (example)
... patient-clinicalTrial I0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... id 0..1stringxml:id (or equivalent in JSON)
.... NCT I1..1stringExtension
URL: NCT
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"NCT"
..... valueString 1..1stringValue of extension
.... period I0..1PeriodExtension
URL: period
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"period"
..... valuePeriod 1..1PeriodValue of extension
.... reason I0..1CodeableConceptExtension
URL: reason
Binding: 7.org/fhir/daf/ValueSet/daf-problem (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"reason"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial"
... patient-birthTime SI0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierAn identifier for this patient
... active ?!S0..1booleanWhether this patient's record is in active use
... name ∑0..*HumanNameA name associated with the patient
... telecom 0..*ContactPointA contact detail for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... iso21090-preferred I0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system ∑I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value ∑0..1stringThe actual contact point details
.... use ?!∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... gender S0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S0..1dateThe date of birth for the individual
... deceased[x] ?!S0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S0..*AddressAddresses for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... iso21090-preferred I0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: v2 Contact Role (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
..... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
..... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
..... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
..... city ∑0..1stringName of city, town etc.
Example: Erewhon
..... district ∑0..1stringDistrict name (aka county)
Example: Madison
..... state 0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
..... postalCode ∑0..1stringPostal code for area
Example: 9132
..... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
..... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Profile qicore-organization)A grouping of people or organizations with a common purpose
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA list of Languages 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
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Common Languages (extensible)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Profile qicore-organization | Profile qicore-practitioner)Patient's nominated primary care provider
... managingOrganization 0..1Reference(Profile qicore-organization)A grouping of people or organizations with a common purpose
... link ?!0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1Reference(Profile qicore-patient)The other patient or related person resource that the link refers to
.... type ?!∑1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Differential View

This structure is derived from StructureDefinition.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... active S0..1boolean
... telecom 0..*ContactPoint
.... iso21090-preferred 0..1booleanpreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... gender S0..1code
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... state 0..1stringBinding: USPS Two Letter Alphabetic Codes (preferred)
.... iso21090-preferred 0..1booleanpreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... contact 0..*BackboneElement
.... address 0..1Address
..... state 0..1stringBinding: USPS Two Letter Alphabetic Codes (preferred)
.... organization 0..1Reference(Profile qicore-organization)
... animal 0..0
... communication S0..*BackboneElement
... generalPractitioner 0..*Reference(Profile qicore-organization | Profile qicore-practitioner)
... managingOrganization 0..1Reference(Profile qicore-organization)
... link 0..*BackboneElement
.... other 1..1Reference(Profile qicore-patient)
... us-core-race S0..1CodeableConceptA category of humans sharing history, origin or nationality
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: v3 Code System Race (required)
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: v3 Code System Ethnicity (required)
... us-core-religion 0..1CodeableConceptPatient's professed religious affiliation
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (required)
... birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... patient-disability 0..*CodeableConceptCondition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Binding: Disability Value Set (preferred)
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... period 0..1PeriodNationality Period
URL: period
... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... extension 0..1?? http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient-militaryServiceURL: http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient-militaryService
Binding: Military Service Codes (example)
... patient-clinicalTrial 0..*(Complex)The patient's participation in clinical trials
URL: http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
.... NCT 1..1stringNational Clinical Trial number
URL: NCT
.... period 0..1PeriodThe period of participation in the clinical trial
URL: period
.... reason 0..1CodeableConceptThe reason for participation in the clinical trial
URL: reason
Binding: 7.org/fhir/daf/ValueSet/daf-problem (preferred)
... patient-birthTime S0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*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-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: v3 Code System Race (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... us-core-ethnicity SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: v3 Code System Ethnicity (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... us-core-religion I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... birthPlace I0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... patient-disability I0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Binding: Disability Value Set (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... patient-nationality I0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..1ExtensionNationality Code
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"code"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... extension 0..1ExtensionNationality Period
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"period"
..... valuePeriod 1..1PeriodValue of extension
.... period 0..1PeriodExtension
URL: period
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... patient-cadavericDonor I0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... extension 0..1?? http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient-militaryServiceExtension
URL: http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient-militaryService
Binding: Military Service Codes (example)
... patient-clinicalTrial I0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... id 0..1stringxml:id (or equivalent in JSON)
.... NCT I1..1stringExtension
URL: NCT
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"NCT"
..... valueString 1..1stringValue of extension
.... period I0..1PeriodExtension
URL: period
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"period"
..... valuePeriod 1..1PeriodValue of extension
.... reason I0..1CodeableConceptExtension
URL: reason
Binding: 7.org/fhir/daf/ValueSet/daf-problem (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"reason"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial"
... patient-birthTime SI0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierAn identifier for this patient
... active ?!S0..1booleanWhether this patient's record is in active use
... name ∑0..*HumanNameA name associated with the patient
... telecom 0..*ContactPointA contact detail for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... iso21090-preferred I0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system ∑I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value ∑0..1stringThe actual contact point details
.... use ?!∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... gender S0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S0..1dateThe date of birth for the individual
... deceased[x] ?!S0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S0..*AddressAddresses for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... iso21090-preferred I0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: v2 Contact Role (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
..... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
..... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
..... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
..... city ∑0..1stringName of city, town etc.
Example: Erewhon
..... district ∑0..1stringDistrict name (aka county)
Example: Madison
..... state 0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
..... postalCode ∑0..1stringPostal code for area
Example: 9132
..... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
..... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Profile qicore-organization)A grouping of people or organizations with a common purpose
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA list of Languages 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
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Common Languages (extensible)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Profile qicore-organization | Profile qicore-practitioner)Patient's nominated primary care provider
... managingOrganization 0..1Reference(Profile qicore-organization)A grouping of people or organizations with a common purpose
... link ?!0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1Reference(Profile qicore-patient)The other patient or related person resource that the link refers to
.... type ?!∑1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Patient.languageCommon LanguagesextensibleCommon Languages
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-race		?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-race
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-ethnicity		?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-ethnicity
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-religion		v3 Code System ReligiousAffiliationextensiblev3 Code System ReligiousAffiliation
Patient.extension
http://hl7.org/fhir/StructureDefinition/patient-disability		Disability Value SetpreferredDisability Value Set
Patient.extension
http://hl7.org/fhir/qicore/StructureDefinition/qicore-patient-militaryService		Military Service CodesexampleMilitary Service Codes
Patient.extension.extension
http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial#reason		?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-problem
Patient.telecom.systemContactPointSystemrequiredContactPointSystem
Patient.telecom.useContactPointUserequiredContactPointUse
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.address.useAddressUserequiredAddressUse
Patient.address.typeAddressTyperequiredAddressType
Patient.address.stateUSPS Two Letter Alphabetic CodespreferredUSPS Two Letter Alphabetic Codes
Patient.maritalStatusMarital Status CodesrequiredMarital Status Codes
Patient.contact.relationshipv2 Contact Roleextensiblev2 Contact Role
Patient.contact.address.useAddressUserequiredAddressUse
Patient.contact.address.typeAddressTyperequiredAddressType
Patient.contact.address.stateUSPS Two Letter Alphabetic CodespreferredUSPS Two Letter Alphabetic Codes
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexampleAnimalSpecies
Patient.animal.breedAnimalBreedsexampleAnimalBreeds
Patient.animal.genderStatusGenderStatusexampleGenderStatus
Patient.communication.languageCommon LanguagesextensibleCommon Languages
Patient.link.typeLinkTyperequiredLinkType

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2PatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1PatientIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4PatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3PatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extension.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extension.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extension.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extension.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extension.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extension.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extension.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extension.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extension.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extension.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extension.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extension.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extension.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extension.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extension.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extension.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.telecom.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.telecom.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Patient.address.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Patient.address.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
pat-1Patient.contactSHALL at least contain a contact's details or a reference to an organization
XPath: exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)
.