electronic Case Reporting (eCR) Implementation Guide: STU2 Ballot

This page is part of the electronic Case Reporting (eCR) (v0.2.0: STU 1 Ballot 2) based on FHIR R3. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

SD.2 StructureDefinition-ecr-patient

eCR Profile: ecr-patient

Scope and Usage

This profile represents an eCR Patient. It is based on the US Core Patient and further restricts that profile to allow masking of some elements.

Additional Profile specific implementation guidance:

  • None

Examples

SD.2.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

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

Published on Wed Aug 01 00:00:00 AEST 2018 as a draft by .

This profile builds on US Core Patient Profile

Summary

Mandatory: 2 elements (11 nested mandatory elements)
Must-Support: 35 elements
Fixed Value: 6 elements

Extensions

This structure refers to these extensions:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient S0..*eCR Patient
... us-core-race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... us-core-birthsex S0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: US Core Birth Sex Value Set (required)
... identifier S1..*Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeRequired Pattern: masked
... name 1..*HumanName
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeRequired Pattern: masked
... telecom S0..*ContactPoint
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeRequired Pattern: masked
... gender S1..1code
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeRequired Pattern: masked
... birthDate S0..1date
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeRequired Pattern: masked
... address S0..*Address
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeRequired Pattern: masked
... contact S0..*BackboneElement
.... relationship S1..1CodeableConcept
.... name S0..1HumanName
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... valueCode S1..1codeRequired Pattern: masked
.... telecom S0..*ContactPoint
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... valueCode S1..1codeRequired Pattern: masked
.... address S0..1Address
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... valueCode S1..1codeRequired Pattern: masked
... communication S0..*BackboneElement
.... language S1..1CodeableConcept
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... data-absent-reason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... valueCode S1..1codeRequired Pattern: masked

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient SI0..*eCR Patient
... 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
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-race SI0..1(Complex)Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity SI0..1(Complex)Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... us-core-birthsex SI0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: US Core Birth Sex Value Set (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... data-absent-reason S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value SΣ1..1stringThe value that is unique within the system.
Example General': 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 ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... data-absent-reason S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
.... 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..*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 SΣ0..*ContactPointA contact detail for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... data-absent-reason S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
.... system ΣI0..1codephone | fax | email | pager | url | sms | 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 SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... data-absent-reason SI0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
.... value 0..1Primitive value for code
... birthDate SΣ0..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... data-absent-reason SI0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
.... value 0..1Primitive value for date
... deceased[x] ?!Σ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address SΣ0..*AddressAddresses for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... data-absent-reason S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
.... use ?!Σ0..1codehome | work | temp | old - 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 Σ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 Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General': 9132
.... country Σ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-23T00:00:00+10:00","end":"2010-07-01T00:00:00+10:00"}
... 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
.... relationship S1..1CodeableConceptThe kind of relationship
Binding: v2 Contact Role (extensible)
.... name S0..1HumanNameA name associated with the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... data-absent-reason S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ0..1stringText representation of the full name
..... family Σ0..1stringFamily name (often called 'Surname')
..... given Σ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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... data-absent-reason S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
..... system ΣI0..1codephone | fax | email | pager | url | sms | 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
.... address S0..1AddressAddress for the contact person
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... data-absent-reason S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
..... use ?!Σ0..1codehome | work | temp | old - 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 Σ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 Σ0..1stringName of city, town etc.
Example General': Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General': Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General': 9132
..... country Σ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-23T00:00:00+10:00","end":"2010-07-01T00:00:00+10:00"}
.... 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 SI0..*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: Language codes with language and optionally a region modifier (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... data-absent-reason S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... valueCode S1..1codeValue of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... 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
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

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

 

source: ecr-patient.md file

This is the search markdown file that gets inserted into the sd.html Quick Start section for explanation of the search requirements.