STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: DAF-patient

The official URL for this profile is: 

http://hl7.org/fhir/us/daf/StructureDefinition/daf-patient

This profile was published on Thu Aug 21 00:00:00 AEST 2014 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.4.1.1 Formal Views of Profile Content

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

This structure is derived from Profile daf-core-patient

Summary

Mandatory: 0 element (+7 nested mandatory elements)
Must-Support: 30 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Profile daf-core-patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... active S0..1boolean
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... use S0..1code
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... line S1..*string
.... city S1..1string
.... state S1..1stringBinding: USPS Two Letter Alphabetic Codes (required)
.... postalCode SI1..1string1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S1..1string
... maritalStatus S0..1CodeableConcept
... multipleBirth[x] S0..1boolean, integer
... contact S0..*BackboneElement
.... relationship S0..*CodeableConceptBinding: patient-contact-relationship (required)
.... name S0..1HumanName
.... telecom S0..*ContactPoint
.... address S0..1Address
..... use S0..1code
..... line S0..*string
..... city S0..1string
..... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (required)
..... postalCode SI0..1string2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
..... country S0..1stringBinding: w.iso.org/iso/country_codes.htm (required)
... animal 0..0
... generalPractitioner S0..*Reference(Profile daf-organization | Profile daf-pract)
... managingOrganization S0..1Reference(Profile daf-organization)
... us-core-religion S0..1CodeableConceptPatient's professed religious affiliation
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (required)
... patient-mothersMaidenName S0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/birthPlace

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
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/us-core-race"
.... valueCodeableConcept S1..1CodeableConceptValue of extension
Binding: v3 Code System Race (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding ∑CodingCode defined by a terminology system
Slice: Unordered, Open, by code|true|ordered
..... coding S0..*CodingCode defined by a terminology system
..... coding S1..1CodingCode defined by a terminology system
Binding: OMB Race Categories (required)
..... coding S0..*CodingCode defined by a terminology system
Binding: v3 Code System Race (extensible)
..... text ∑0..1stringPlain text representation of the concept
... 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-birthsex SI0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-birthsex
Binding: USRealm Birth Sex Value Set (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 S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (required)
... patient-mothersMaidenName S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... birthPlace S0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierAn identifier for this patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S1..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!S0..1booleanWhether this patient's record is in active use
... name S1..*HumanNameA name associated with the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ∑0..1stringText representation of the full name
.... family S1..*stringFamily name (often called 'Surname')
.... given S1..*stringGiven names (not always 'first'). Includes middle names
.... prefix ∑0..*stringParts that come before the name
.... suffix ∑0..*stringParts that come after the name
.... period ∑0..1PeriodTime period when name was/is in use
... telecom S0..*ContactPointA contact detail for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system SI1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value S1..1stringThe actual contact point details
.... use ?!S0..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 S1..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)
.... 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 S1..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S1..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode SI1..1stringPostal code for area
1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S1..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 S0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] S0..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
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 S0..*CodeableConceptThe kind of relationship
Binding: patient-contact-relationship (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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!S0..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 S0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
..... city S0..1stringName of city, town etc.
Example: Erewhon
..... district ∑0..1stringDistrict name (aka county)
Example: Madison
..... state S0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
..... postalCode SI0..1stringPostal code for area
2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
..... country S0..1stringCountry (can be ISO 3166 3 letter code)
Binding: w.iso.org/iso/country_codes.htm (required)
..... 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(Organization)Organization that is associated with the contact
.... 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 S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Common Languages (required)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner S0..*Reference(Profile daf-organization | Profile daf-pract)Patient's nominated primary care provider
... managingOrganization S0..1Reference(Profile daf-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(Patient | RelatedPerson)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

This structure is derived from Patient.

Summary

Mandatory: 0 element (+7 nested mandatory elements)
Must-Support: 30 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... active S0..1boolean
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... use S0..1code
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... line S1..*string
.... city S1..1string
.... state S1..1stringBinding: USPS Two Letter Alphabetic Codes (required)
.... postalCode SI1..1string1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S1..1string
... maritalStatus S0..1CodeableConcept
... multipleBirth[x] S0..1boolean, integer
... contact S0..*BackboneElement
.... relationship S0..*CodeableConceptBinding: patient-contact-relationship (required)
.... name S0..1HumanName
.... telecom S0..*ContactPoint
.... address S0..1Address
..... use S0..1code
..... line S0..*string
..... city S0..1string
..... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (required)
..... postalCode SI0..1string2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
..... country S0..1stringBinding: w.iso.org/iso/country_codes.htm (required)
... animal 0..0
... generalPractitioner S0..*Reference(Profile daf-organization | Profile daf-pract)
... managingOrganization S0..1Reference(Profile daf-organization)
... us-core-religion S0..1CodeableConceptPatient's professed religious affiliation
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (required)
... patient-mothersMaidenName S0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/birthPlace

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
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/us-core-race"
.... valueCodeableConcept S1..1CodeableConceptValue of extension
Binding: v3 Code System Race (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding ∑CodingCode defined by a terminology system
Slice: Unordered, Open, by code|true|ordered
..... coding S0..*CodingCode defined by a terminology system
..... coding S1..1CodingCode defined by a terminology system
Binding: OMB Race Categories (required)
..... coding S0..*CodingCode defined by a terminology system
Binding: v3 Code System Race (extensible)
..... text ∑0..1stringPlain text representation of the concept
... 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-birthsex SI0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-birthsex
Binding: USRealm Birth Sex Value Set (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 S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (required)
... patient-mothersMaidenName S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... birthPlace S0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierAn identifier for this patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S1..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!S0..1booleanWhether this patient's record is in active use
... name S1..*HumanNameA name associated with the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ∑0..1stringText representation of the full name
.... family S1..*stringFamily name (often called 'Surname')
.... given S1..*stringGiven names (not always 'first'). Includes middle names
.... prefix ∑0..*stringParts that come before the name
.... suffix ∑0..*stringParts that come after the name
.... period ∑0..1PeriodTime period when name was/is in use
... telecom S0..*ContactPointA contact detail for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system SI1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value S1..1stringThe actual contact point details
.... use ?!S0..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 S1..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)
.... 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 S1..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S1..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode SI1..1stringPostal code for area
1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S1..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 S0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] S0..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
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 S0..*CodeableConceptThe kind of relationship
Binding: patient-contact-relationship (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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!S0..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 S0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
..... city S0..1stringName of city, town etc.
Example: Erewhon
..... district ∑0..1stringDistrict name (aka county)
Example: Madison
..... state S0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
..... postalCode SI0..1stringPostal code for area
2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
..... country S0..1stringCountry (can be ISO 3166 3 letter code)
Binding: w.iso.org/iso/country_codes.htm (required)
..... 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(Organization)Organization that is associated with the contact
.... 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 S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Common Languages (required)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner S0..*Reference(Profile daf-organization | Profile daf-pract)Patient's nominated primary care provider
... managingOrganization S0..1Reference(Profile daf-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(Patient | RelatedPerson)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.valueCodeableConceptv3 Code System Racerequiredv3 Code System Race
Patient.extension.valueCodeableConcept.codingv3 Code System Raceextensiblev3 Code System Race
Patient.extension.valueCodeableConcept.codingv3 Code System Raceextensiblev3 Code System Race
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-ethnicity		Ethnicity grouprequiredEthnicity group
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-birthsex		USRealm Birth Sex Value SetrequiredUSRealm Birth Sex Value Set
Patient.extension
http://hl7.org/fhir/StructureDefinition/us-core-religion		v3 Code System ReligiousAffiliationextensiblev3 Code System ReligiousAffiliation
Patient.identifier.useIdentifierUserequiredIdentifierUse
Patient.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Patient.name.useNameUserequiredNameUse
Patient.telecom.systemContactPointSystemrequiredContactPointSystem
Patient.telecom.useContactPointUserequiredContactPointUse
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.address.useAddressUserequiredAddressUse
Patient.address.typeAddressTyperequiredAddressType
Patient.address.stateUSPS Two Letter Alphabetic CodesrequiredUSPS Two Letter Alphabetic Codes
Patient.maritalStatusMarital Status CodesrequiredMarital Status Codes
Patient.contact.relationship?extrequiredhttp://hl7.org/fhir/ValueSet/patient-contact-relationship
Patient.contact.address.useAddressUserequiredAddressUse
Patient.contact.address.typeAddressTyperequiredAddressType
Patient.contact.address.stateUSPS Two Letter Alphabetic CodesrequiredUSPS Two Letter Alphabetic Codes
Patient.contact.address.country?extrequiredhttp://www.iso.org/iso/country_codes.htm
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexampleAnimalSpecies
Patient.animal.breedAnimalBreedsexampleAnimalBreeds
Patient.animal.genderStatusGenderStatusexampleGenderStatus
Patient.communication.languageCommon LanguagesrequiredCommon 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))]))
1Patient.address.postalCode(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
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)
2Patient.contact.address.postalCode(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
.