2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: HSPCPatient

The official URL for this profile is: 

http://hl7.org/fhir/Profile/patient-hspc-hspcpatient

. Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information. : Health Service Platform Consortium (HSPC) Patient Profile

This profile was published on Thu, Feb 5, 2015 00:00+1100 as a draft by U.S. Office of the National Coordinator (ONC).

unable to summarise extension (wrong count)

Formal Views of Profile Content

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

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1
... telecom 0..*
.... iso21090-preferred 0..1booleanpreferred
... birthDate 0..1
.... iso21090-verification 0..1CodeableConceptverification
Binding: HSPCVerification (preferred, extensible)
... address 0..*
.... iso21090-preferred 0..1booleanpreferred
... animal 0..0=Animal
... communication 0..*
.... patient-hspc-communicationMode 0..1CodeableConceptCommunication Mode
... patient-race 0..*CodeableConceptRace
Binding: HSPCRace (preferred, extensible)
... patient-ethnicity 0..1CodeableConceptEthnicity
Binding: HSPCEthnicity (preferred, extensible)
... patient-religion 0..1CodeableConceptReligion
Binding: HSPCReligion (preferred, extensible)
... patient-mothersMaidenName 0..1stringMother's Maiden name
... patient-birthPlace 0..1stringBirthplace
... patient-disability 0..1CodeableConceptDisability Code
... patient-hspc-importance 0..1CodeableConceptImportance
Binding: HSPCImportance (preferred, extensible)
... patient-nationality 0..*NationalityNationality
.... patient-nationalityCode 1..1CodeableConceptNationality Code
.... patient-nationalityPeriod 0..1PeriodNationality Period
... patient-citizenship 0..*CitizenshipCitizenship
.... patient-citizenshipCode 1..1CodeableConceptCitizenship Code
.... patient-citizenshipPeriod 0..1PeriodCitizenship Period
... patient-cadavericDonor 0..1booleanCadaveric Donor
... patient-congregation 0..1stringCongregation
... patient-veteranMilitaryStatus 0..1CodeableConceptVeteran Military Status
... patient-adoptionInfo 0..1CodeableConceptAdoption Information

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Information about a person or animal receiving health care services
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... patient-race 0..*CodeableConceptAdditional Content defined by implementations
Binding: HSPCRace (preferred, extensible)
... patient-ethnicity 0..1CodeableConceptAdditional Content defined by implementations
Binding: HSPCEthnicity (preferred, extensible)
... patient-religion 0..1CodeableConceptAdditional Content defined by implementations
Binding: HSPCReligion (preferred, extensible)
... patient-mothersMaidenName 0..1stringAdditional Content defined by implementations
... patient-birthPlace 0..1stringAdditional Content defined by implementations
... patient-disability 0..1CodeableConceptAdditional Content defined by implementations
... patient-hspc-importance 0..1CodeableConceptAdditional Content defined by implementations
Binding: HSPCImportance (preferred, extensible)
... patient-nationality 0..*NationalityAdditional Content defined by implementations
.... id 0..1idxml:id (or equivalent in JSON)
.... patient-nationalityCode 1..1CodeableConceptAdditional Content defined by implementations
.... patient-nationalityPeriod 0..1PeriodAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-citizenship 0..*CitizenshipAdditional Content defined by implementations
.... id 0..1idxml:id (or equivalent in JSON)
.... patient-citizenshipCode 1..1CodeableConceptAdditional Content defined by implementations
.... patient-citizenshipPeriod 0..1PeriodAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-cadavericDonor 0..1booleanAdditional Content defined by implementations
... patient-congregation 0..1stringAdditional Content defined by implementations
... patient-veteranMilitaryStatus 0..1CodeableConceptAdditional Content defined by implementations
... patient-adoptionInfo 0..1CodeableConceptAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAn identifier for the person as this patient
... name Σ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... iso21090-preferred 0..1booleanAdditional Content defined by implementations
.... system I0..1codephone | fax | email | url
Binding: ContactPointSystem (required, not extensible)
.... value 0..1stringThe actual contact point details
.... use M0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required, not extensible)
.... period 0..1PeriodTime period when the contact point was/is in use
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
... birthDate Σ0..1dateThe date of birth for the individual
.... iso21090-verification 0..1CodeableConceptAdditional Content defined by implementations
Binding: HSPCVerification (preferred, extensible)
.... value 0..1xsd:xs:gYear, xs:gYearMonth, xs:datePrimitive value for date
... birthTime Σ0..1timeThe time of birth for the individual
... deceased[x] M Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address Σ0..*AddressAddresses for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... iso21090-preferred 0..1booleanAdditional Content defined by implementations
.... use M0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
Example: home
.... 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
.... state 0..1stringSub-unit of country (abreviations ok)
.... 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 person
Binding: MaritalStatus (preferred, extensible)
... multipleBirth[x] Σ0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the person
... contact I0..*A 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..1idxml: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: ContactRelationship (preferred, extensible)
.... name 0..1HumanNameA name associated with the person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
.... organization I0..1OrganizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this person or organization is valid to be contacted relating to this patient
... communication 0..*CodeableConceptLanguages which may be used to communicate with the patient about his or her health
Binding: Language (required, not extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... patient-hspc-communicationMode 0..1CodeableConceptAdditional Content defined by implementations
.... coding 0..*CodingCode defined by a terminology system
.... text 0..1stringPlain text representation of the concept
... careProvider 0..*Organization, PractitionerPatient's nominated care provider
... managingOrganization Σ0..1OrganizationOrganization that is the custodian of the patient record
... link M Σ0..*Link to another patient resource that concerns the same actual person
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... other M Σ1..1PatientThe other patient resource that the link refers to
.... type M Σ1..1codereplace | refer | seealso - type of link
Binding: LinkType (required, not extensible)
... active M Σ0..1booleanWhether this patient's record is in active use

XML Template

JSON Template

todo

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1
... telecom 0..*
.... iso21090-preferred 0..1booleanpreferred
... birthDate 0..1
.... iso21090-verification 0..1CodeableConceptverification
Binding: HSPCVerification (preferred, extensible)
... address 0..*
.... iso21090-preferred 0..1booleanpreferred
... animal 0..0=Animal
... communication 0..*
.... patient-hspc-communicationMode 0..1CodeableConceptCommunication Mode
... patient-race 0..*CodeableConceptRace
Binding: HSPCRace (preferred, extensible)
... patient-ethnicity 0..1CodeableConceptEthnicity
Binding: HSPCEthnicity (preferred, extensible)
... patient-religion 0..1CodeableConceptReligion
Binding: HSPCReligion (preferred, extensible)
... patient-mothersMaidenName 0..1stringMother's Maiden name
... patient-birthPlace 0..1stringBirthplace
... patient-disability 0..1CodeableConceptDisability Code
... patient-hspc-importance 0..1CodeableConceptImportance
Binding: HSPCImportance (preferred, extensible)
... patient-nationality 0..*NationalityNationality
.... patient-nationalityCode 1..1CodeableConceptNationality Code
.... patient-nationalityPeriod 0..1PeriodNationality Period
... patient-citizenship 0..*CitizenshipCitizenship
.... patient-citizenshipCode 1..1CodeableConceptCitizenship Code
.... patient-citizenshipPeriod 0..1PeriodCitizenship Period
... patient-cadavericDonor 0..1booleanCadaveric Donor
... patient-congregation 0..1stringCongregation
... patient-veteranMilitaryStatus 0..1CodeableConceptVeteran Military Status
... patient-adoptionInfo 0..1CodeableConceptAdoption Information

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Information about a person or animal receiving health care services
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... patient-race 0..*CodeableConceptAdditional Content defined by implementations
Binding: HSPCRace (preferred, extensible)
... patient-ethnicity 0..1CodeableConceptAdditional Content defined by implementations
Binding: HSPCEthnicity (preferred, extensible)
... patient-religion 0..1CodeableConceptAdditional Content defined by implementations
Binding: HSPCReligion (preferred, extensible)
... patient-mothersMaidenName 0..1stringAdditional Content defined by implementations
... patient-birthPlace 0..1stringAdditional Content defined by implementations
... patient-disability 0..1CodeableConceptAdditional Content defined by implementations
... patient-hspc-importance 0..1CodeableConceptAdditional Content defined by implementations
Binding: HSPCImportance (preferred, extensible)
... patient-nationality 0..*NationalityAdditional Content defined by implementations
.... id 0..1idxml:id (or equivalent in JSON)
.... patient-nationalityCode 1..1CodeableConceptAdditional Content defined by implementations
.... patient-nationalityPeriod 0..1PeriodAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-citizenship 0..*CitizenshipAdditional Content defined by implementations
.... id 0..1idxml:id (or equivalent in JSON)
.... patient-citizenshipCode 1..1CodeableConceptAdditional Content defined by implementations
.... patient-citizenshipPeriod 0..1PeriodAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... patient-cadavericDonor 0..1booleanAdditional Content defined by implementations
... patient-congregation 0..1stringAdditional Content defined by implementations
... patient-veteranMilitaryStatus 0..1CodeableConceptAdditional Content defined by implementations
... patient-adoptionInfo 0..1CodeableConceptAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierAn identifier for the person as this patient
... name Σ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... iso21090-preferred 0..1booleanAdditional Content defined by implementations
.... system I0..1codephone | fax | email | url
Binding: ContactPointSystem (required, not extensible)
.... value 0..1stringThe actual contact point details
.... use M0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required, not extensible)
.... period 0..1PeriodTime period when the contact point was/is in use
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
... birthDate Σ0..1dateThe date of birth for the individual
.... iso21090-verification 0..1CodeableConceptAdditional Content defined by implementations
Binding: HSPCVerification (preferred, extensible)
.... value 0..1xsd:xs:gYear, xs:gYearMonth, xs:datePrimitive value for date
... birthTime Σ0..1timeThe time of birth for the individual
... deceased[x] M Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address Σ0..*AddressAddresses for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... iso21090-preferred 0..1booleanAdditional Content defined by implementations
.... use M0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
Example: home
.... 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
.... state 0..1stringSub-unit of country (abreviations ok)
.... 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 person
Binding: MaritalStatus (preferred, extensible)
... multipleBirth[x] Σ0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the person
... contact I0..*A 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..1idxml: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: ContactRelationship (preferred, extensible)
.... name 0..1HumanNameA name associated with the person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
.... organization I0..1OrganizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this person or organization is valid to be contacted relating to this patient
... communication 0..*CodeableConceptLanguages which may be used to communicate with the patient about his or her health
Binding: Language (required, not extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... patient-hspc-communicationMode 0..1CodeableConceptAdditional Content defined by implementations
.... coding 0..*CodingCode defined by a terminology system
.... text 0..1stringPlain text representation of the concept
... careProvider 0..*Organization, PractitionerPatient's nominated care provider
... managingOrganization Σ0..1OrganizationOrganization that is the custodian of the patient record
... link M Σ0..*Link to another patient resource that concerns the same actual person
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... other M Σ1..1PatientThe other patient resource that the link refers to
.... type M Σ1..1codereplace | refer | seealso - type of link
Binding: LinkType (required, not extensible)
... active M Σ0..1booleanWhether this patient's record is in active use

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Patient.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.extensionHSPCImportancepreferred (extensible)Importance
Patient.extensionHSPCImportancepreferred (extensible)Importance
Patient.extensionHSPCImportancepreferred (extensible)Importance
Patient.extensionHSPCImportancepreferred (extensible)Importance
Patient.telecom.systemContactPointSystemrequiredContactPointSystem
Patient.telecom.useContactPointUserequiredContactPointUse
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.birthDate.extensionHSPCVerificationpreferred (extensible)HSPC Verification
Patient.address.useAddressUserequiredAddressUse
Patient.maritalStatusMaritalStatuspreferred (extensible)Marital Status Codes
Patient.contact.relationshipContactRelationshippreferred (extensible)PatientContactRelationship
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexample (extensible)AnimalSpecies
Patient.animal.breedAnimalBreedexample (extensible)AnimalBreeds
Patient.animal.genderStatusAnimalGenderStatusexample (extensible)GenderStatus
Patient.communicationLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.link.typeLinkTyperequiredLinkType

Constraints

IdPathNameDetails
pat-1Patient.contactContactNeedsDetailsSHALL at least contain a contact's details or a reference to an organization
XPath: f:name or f:telecom or f:address or f:organization
.